Documentación de la API

La API de BoundaryAI te permite enviar datos de feedback de forma programática, crear fuentes de datos y gestionar el flujo de trabajo de recopilación de feedback de tu organización.

Resumen

La API de BoundaryAI le permite importar programáticamente datos de retroalimentación desde cualquier fuente: tickets de soporte, exportaciones de CRM, encuestas, registros de chat, y aprovechar el análisis impulsado por IA para extraer ideas.

Conceptos centrales

Antes de profundizar, comprenda estos conceptos clave:

Concepto

Descripción

Grupo de Opiniones

Un contenedor que organiza fuentes de datos relacionadas (p. ej., "Retroalimentación de clientes Q1 2024")

Fuente de datos

Una colección de retroalimentación dentro de un grupo (p. ej., "Tickets de Zendesk", "Encuesta NPS")

Pregunta

Un campo dentro de una fuente de datos que contiene texto de retroalimentación

APS

Puntos de Análisis - créditos consumidos al enviar contenido para análisis por IA

Cómo funciona

1. Cree un Grupo de Retroalimentación (o use uno existente)
         ↓
2. Cree una Fuente de Datos con Preguntas
         ↓
3. Publique la Fuente de Datos
         ↓
4. Envíe su contenido de retroalimentación
         ↓
5. BoundaryAI analiza y extrae ideas

Autenticación

Claves de API

Todas las solicitudes de API requieren una clave de API pasada en el Autorización encabezado:

Authorization: Bearer inpk_live_abc123xyz_SbcEpUl9DWuI8IOI-YImkxPNSisaAab7t0goFuliM-4

Formato de la clave

inpk_{environment}_{key_id}_{secret}

Parte

Descripción

inpk

Prefijo fijo (Clave de API de Entrada)

environment

live (producción) o test (sin deducción de APS)

key_id

Identificador único de 10 caracteres

secret

Secreto codificado en Base64 (44 caracteres)

Permisos de la clave

Al crear una clave de API, elige su nivel de permiso:

Permiso

Puede hacer

Caso de uso

push

Enviar contenido a fuentes de datos existentes

Scripts de importación automatizados

create

Crear grupos de retroalimentación y fuentes de datos

Configurar automatizaciones

all

Todo

Control programático completo

Obtener su clave de API

Vaya a Integraciones → API en su panel de BoundaryAI
Haz clic Crear clave de API
Elija un nombre, entorno y nivel de permiso
Guarde la clave de inmediato — ¡solo se muestra una vez!

Notas de seguridad

Las claves se hashéan en el servidor; nunca almacenamos el texto sin formato
Use test claves de entorno para pruebas (sin cargos de APS)
Rote las claves regularmente a través del panel (no olvide copiarlas después de rotarlas ya que también aparecen solo una vez)

Realizar solicitudes

URLs base

Entorno

URL base

Europa

https://app.boundary-ai.com/

Norteamérica

https://app.boundary-ai.com/

APAC

Próximamente

Formato de la solicitud

Todas las solicitudes deben incluir:

Authorization: Bearer {your_api_key}
Content-Type: application/json

Formato de respuesta

Respuesta exitosa

{
  "status": "success",
  "inserted": 3,
  "aps_deducted": 3,
  "question_id": 736,
  "survey_id": 287,
  "survey_series_id": 2
}

Respuesta de error

{
  "error": {
    "code": "SURVEY_NOT_FOUND",
    "message": "La fuente de datos con ID 999 no existe",
    "details": {}
  }
}

Limitación de tasa

Tres capas protegen la API:

Capa

Límite

Ámbito

Por clave

60/min (máx. = 300)

Clave de API individual

Por organización

1000/min

Todas las claves en la organización

Por IP

1000/min

Protección de respaldo

Encabezados de respuesta:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1704067200

Cuando se excede la tasa, recibirá HTTP 429 con un Retry-After encabezado.

Idempotencia

Evite duplicados incluyendo una clave de idempotencia:

Idempotency-Key: import-batch-2024-01-15-001

Escenario

Resultado

Primera solicitud

Se ejecuta normalmente, almacena en caché la respuesta durante 24 h

Misma clave + misma carga

Devuelve la respuesta en caché (no hay inserción duplicada)

Misma clave + carga diferente

Devuelve HTTP 409 error de conflicto

Mejor práctica: Use un identificador único como {source}-{date}-{batch} para cada lote de importación.

Referencia de endpoints

Referencia rápida

Método

Endpoint

Descripción

Permiso

GET

/api/input/surveys/list

Listar todos los grupos de retroalimentación y fuentes de datos

cualquiera

POST

/api/input/survey_series/create

Crear un grupo de retroalimentación

create

POST

/api/input/survey/create

Crear una fuente de datos

create

POST

/api/input/survey/publish

Publicar una fuente de datos

create

POST

/api/input/content/push

Enviar contenido a una pregunta

push

POST

/api/input/content/push/bulk

Enviar contenido a múltiples preguntas

push

Listar fuentes de datos

Recupere todos los grupos de retroalimentación y fuentes de datos a los que su clave de API puede acceder. Ejecute esto primero para obtener los ID que necesita para enviar contenido.

GET /api/input/surveys/list

Parámetros de consulta

Parámetro

Tipo

Descripción

survey_series_id

entero

Filtrar a un grupo de retroalimentación específico

survey_id

entero

Filtrar a una fuente de datos específica

Respuesta

{
  "org_id": 1,
  "survey_series": [
    {
      "id": 101,
      "name": "Registros de soporte al cliente",
      "surveys": [
        {
          "id": 505,
          "title": "Exportación de chat en vivo",
          "description": "Descripción de la encuesta aquí",
          "mode": "ACCESSIBLE",
          "questions": [
            {
              "id": 888,
              "title": "Mensaje del usuario",
              "type": "long_answer",
              "accepts_text": true
            }
          ]
        }
      ]
    }
  ]
}

Comprender la respuesta

Campo

Descripción

survey_series

Matriz de grupos de retroalimentación

surveys

Matriz de fuentes de datos dentro de un grupo

questions

Campos disponibles para contenido

accepts_text

¡Importante! Solo envíe texto a preguntas donde esto sea true

mode

ACCESSIBLE = publicado, EDITING = borrador

Ejemplo

curl -X GET "https://app.boundary-ai.com/api/input/surveys/list" \
  -H "Authorization: Bearer $API_KEY"

Enviar contenido

Enviar texto de retroalimentación a una pregunta específica. Este es el endpoint principal para importar datos.

POST /api/input/content/push

Cuerpo de la solicitud

{
  "survey_series_id": "123",
  "survey_id": "456",
  "question": {
    "question_id": "789",
    "content": [
      "El proceso de pago fue confuso",
      "¡Me encanta la nueva función de modo oscuro!",
      "La aplicación se bloquea al subir archivos grandes"
    ]
  },
  "source_reference": "zendesk-export-2024-01-15"
}

Parámetros

Campo

Tipo

Requerido

Descripción

survey_series_id

cadena

Sí

ID del grupo de retroalimentación

survey_id

cadena

Sí

ID de la fuente de datos

question.question_id

cadena

Sí

ID de la pregunta (debe tener accepts_text: true)

question.content

matriz

Sí

Matriz de cadenas de retroalimentación

source_reference

cadena

Su referencia para este lote de importación

Límites de contenido

Límite

Valor

Máx. elementos por solicitud

1,000

Máx. caracteres por elemento

10,000

Respuesta

{
  "status": "success",
  "inserted": 3,
  "aps_deducted": 3,
  "question_id": 736,
  "survey_id": 287,
  "survey_series_id": 2
}

Campo

Descripción

inserted

Número de nuevas entradas agregadas

duplicates

Número de entradas duplicadas omitidas

aps_deducted

Puntos de análisis consumidos

Ejemplo: Python

import requests

API_KEY = "inpk_live_xxx_yyy"
BASE_URL = "https://app.boundary-ai.com"

response = requests.post(
    f"{BASE_URL}/api/input/content/push",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={
        "survey_series_id": "123",
        "survey_id": "456",
        "question": {
            "question_id": "789",
            "content": [
                "¡Gran producto, fácil de usar!",
                "El equipo de soporte fue muy servicial",
                "Lo recomendaría a otros"
            ]
        },
        "source_reference": "crm-export-2024-01"
    }
)

result = response.json()
print(f"Insertados: {result['inserted']}, APS usados: {result['aps_deducted']}")

Ejemplo: JavaScript

const API_KEY = 'inpk_live_xxx_yyy';
const BASE_URL = 'https://app.boundary-ai.com';

const response = await fetch(`${BASE_URL}/api/input/content/push`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    survey_series_id: "123",
    survey_id: "456",
    question: {
      question_id: "789",
      content: [
        '¡Gran producto, fácil de usar!',
        'El equipo de soporte fue muy servicial',
        'Lo recomendaría a otros'
      ]
    },
    source_reference: 'crm-export-2024-01'
  })
});

const result = await response.json();
console.log(`Insertados: ${result.inserted}, APS usados: ${result.aps_deducted}`);

Ejemplo: Curl

curl -X POST "https://app.boundary-ai.com/api/input/content/push" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: batch-001" \
  -d '{
    "survey_series_id": "123",
    "survey_id": "456",
    "question": {
      "question_id": "789",
      "content": [
        "¡Gran producto, fácil de usar!",
        "El equipo de soporte fue muy servicial"
      ]
    }
  }'

Enviar contenido en bloque

Enviar contenido a múltiples preguntas en una sola solicitud. Útil cuando sus datos tienen múltiples campos.

POST /api/input/content/push/bulk

Cuerpo de la solicitud

{
  "survey_series_id": "123",
  "survey_id": "456",
  "questions": [
    {
      "question_id": "789",
      "content": ["Retroalimentación para la pregunta 1", "Más retroalimentación"]
    },
    {
      "question_id": "790",
      "content": ["Retroalimentación para la pregunta 2"]
    }
  ],
  "source_reference": "bulk-import-001"
}

Parámetros

Campo

Tipo

Requerido

Descripción

survey_series_id

cadena

Sí

ID del grupo de retroalimentación

survey_id

cadena

Sí

ID de la fuente de datos

questions

matriz

Sí

Matriz de objetos de pregunta (máx. 100)

questions[].question_id

cadena

Sí

ID de la pregunta

questions[].content

matriz

Sí

Matriz de cadenas de retroalimentación

source_reference

cadena

Su referencia para este lote

Respuesta

{
  "status": "success",
  "survey_series_id": 2,
  "survey_id": 287,
  "total_inserted": 2,
  "total_aps_deducted": 2,
  "questions": [
    {"question_id": 736, "inserted": 2, "status": "success"}
  ]
}

Botón Crear Grupo de Opiniones

Cree un nuevo grupo de retroalimentación para organizar fuentes de datos relacionadas.

POST /api/input/survey_series/create

Permiso requerido: create o all

Cuerpo de la solicitud

{
  "name": "Retroalimentación del producto 2024"
}

Parámetros

Campo

Tipo

Requerido

Descripción

nombre

cadena

Sí

Nombre del grupo (2-255 caracteres)

Respuesta

{
  "status": "success",
  "created": true,
  "survey_series": {
    "id": 123,
    "name": "Retroalimentación del producto 2024"
  }
}

Nota: Si existe un grupo con el mismo nombre, devuelve el grupo existente con "created": false.

Crear fuente de datos

Crear una nueva fuente de datos con preguntas dentro de un grupo de retroalimentación.

POST /api/input/survey/create

Permiso requerido: create o all

Cuerpo de la solicitud

{
  "survey_series_id": "123",
  "survey_title": "Importación de tickets de Zendesk",
  "survey_description": "Tickets de soporte de enero de 2024",
  "questions": [
    {
      "question_title": "Contenido del ticket",
      "question_type": "DEPTH_TEXT",
      "is_mandatory": true
    },
    {
      "question_title": "Sentimiento del cliente",
      "question_type": "SCQ",
      "question_options": ["Positivo", "Neutral", "Negativo"],
      "is_mandatory": false
    }
  ]
}

Parámetros

Campo

Tipo

Requerido

Descripción

survey_series_id

cadena

Sí

ID del grupo de retroalimentación padre

survey_title

cadena

Sí

Nombre de la fuente de datos (1-100 caracteres)

survey_description

cadena

Descripción (máx. 1000 caracteres)

questions

matriz

Matriz de preguntas a crear

Tipos de pregunta

Tipo

Alias

Descripción

Acepta texto

DEPTH_TEXT

long_answer

Texto de formato largo (analizado por IA)

✅ Sí

TEXT

short_answer

Texto corto

✅ Sí

MCQ

mcq

Selección múltiple (multi-selección)

❌ No

SCQ

scq

Selección única

❌ No

RATING

rating

Escala 1-5

❌ No

NPS

nps

Net Promoter Score (0-10)

❌ No

Consejo: Use DEPTH_TEXT para el texto de retroalimentación que desea que la IA analice.

Respuesta

{
  "status": "success",
  "survey_series_id": 123,
  "survey_id": 456,
  "questions_created": 2,
  "questions": [
    {"id": 789, "title": "Contenido del ticket", "type": "DEPTH_TEXT"},
    {"id": 790, "title": "Sentimiento del cliente", "type": "SCQ"}
  ],
  "message": "Encuesta 'Importación de tickets de Zendesk' creada con 2 pregunta(s)"
}

Publicar fuente de datos

Publique una fuente de datos para habilitar la recopilación y el análisis de datos.

POST /api/input/survey/publish

Permiso requerido: create o all

Cuerpo de la solicitud

{
  "survey_series_id": 123,
  "survey_id": 456
}

Respuesta

{
  "status": "success",
  "survey_id": 456,
  "survey_series_id": 123,
  "mode": "ACCESSIBLE",
  "message": "Encuesta publicada correctamente"
}

Nota: Debe publicar una fuente de datos antes de poder enviar contenido a la misma.

Webhooks

Vea Webhooks página

Ejemplo completo

Aquí hay un flujo de trabajo completo: cree un grupo de retroalimentación, añada una fuente de datos, publíquela y envíe contenido.

#!/bin/bash
# Ejemplo completo del flujo de trabajo de la API

API_KEY="inpk_live_xxx_yyy"
BASE_URL="https://app.boundary-ai.com"

# Paso 1: Crear un grupo de retroalimentación
echo "Creando grupo de retroalimentación..."
SERIES_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/survey_series/create" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Tickets de soporte Q1 2024"}')

SERIES_ID=$(echo $SERIES_RESPONSE | jq -r '.survey_series.id')
echo "ID de grupo de retroalimentación creado: $SERIES_ID"

# Paso 2: Crear una fuente de datos con una pregunta de texto
echo "Creando fuente de datos..."
SURVEY_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/survey/create" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"survey_series_id\": \"$SERIES_ID\",
    \"survey_title\": \"Importación de Zendesk\",
    \"questions\": [
      {\"question_title\": \"Contenido del ticket\", \"question_type\": \"DEPTH_TEXT\"}
    ]
  }")

SURVEY_ID=$(echo $SURVEY_RESPONSE | jq -r '.survey_id')
QUESTION_ID=$(echo $SURVEY_RESPONSE | jq -r '.questions[0].id')
echo "ID de fuente de datos creado: $SURVEY_ID, ID de pregunta: $QUESTION_ID"

# Paso 3: Publicar la fuente de datos
echo "Publicando fuente de datos..."
curl -s -X POST "$BASE_URL/api/input/survey/publish" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"survey_series_id\": $SERIES_ID, \"survey_id\": $SURVEY_ID}"

# Paso 4: Enviar contenido de retroalimentación
echo "Enviando contenido..."
PUSH_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/content/push" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: zendesk-batch-$(date +%Y%m%d)-001" \
  -d "{
    \"survey_series_id\": \"$SERIES_ID\",
    \"survey_id\": \"$SURVEY_ID\",
    \"question\": {
      \"question_id\": \"$QUESTION_ID\",
      \"content\": [
        \"El proceso de pago fue confuso y me rendí\",
        \"¡Me encanta la nueva función de búsqueda - mucho más rápida!\",
        \"La aplicación se bloquea cada vez que intento subir un PDF\",
        "El soporte al cliente resolvió mi problema en menos de una hora",
        "Sería genial tener la opción de modo oscuro"
      ]
    },
    "source_reference": "zendesk-export-2024-01-15"
  }")

echo "Resultado del push: $PUSH_RESPONSE"
echo ""
echo "¡Hecho! Vea sus comentarios en el panel de BoundaryAI."

Soporte

Correo electrónico: hello@boundary-ai.com
Documentación: docs.boundary-ai.com
Panel: app.boundary-ai.com

AnteriorGuía de inicio rápido SiguienteWebhooks

Última actualización hace 1 mes

hashtagResumen

hashtagConceptos centrales

hashtagCómo funciona

hashtagAutenticación

hashtagClaves de API

hashtagFormato de la clave

hashtagPermisos de la clave

hashtagObtener su clave de API

hashtagNotas de seguridad

hashtagRealizar solicitudes

hashtagURLs base

hashtagFormato de la solicitud

hashtagFormato de respuesta

hashtagRespuesta exitosa

hashtagRespuesta de error

hashtagLimitación de tasa

hashtagIdempotencia

hashtagReferencia de endpoints

hashtagReferencia rápida

hashtagListar fuentes de datos

hashtagParámetros de consulta

hashtagRespuesta

hashtagComprender la respuesta

hashtagEjemplo

hashtagEnviar contenido

hashtagCuerpo de la solicitud

hashtagParámetros

hashtagLímites de contenido

hashtagRespuesta

hashtagEjemplo: Python

hashtagEjemplo: JavaScript

hashtagEjemplo: Curl

hashtagEnviar contenido en bloque

hashtagCuerpo de la solicitud

hashtagParámetros

hashtagRespuesta

hashtagBotón Crear Grupo de Opiniones

hashtagCuerpo de la solicitud

hashtagParámetros

hashtagRespuesta

hashtagCrear fuente de datos

hashtagCuerpo de la solicitud

hashtagParámetros

hashtagTipos de pregunta

hashtagRespuesta

hashtagPublicar fuente de datos

hashtagCuerpo de la solicitud

hashtagRespuesta

hashtagWebhooks

hashtagEjemplo completo

hashtagSoporte

Resumen

Conceptos centrales

Cómo funciona

Autenticación

Claves de API

Formato de la clave

Permisos de la clave

Obtener su clave de API

Notas de seguridad

Realizar solicitudes

URLs base

Formato de la solicitud

Formato de respuesta

Respuesta exitosa

Respuesta de error

Limitación de tasa

Idempotencia

Referencia de endpoints

Referencia rápida

Listar fuentes de datos

Parámetros de consulta

Respuesta

Comprender la respuesta

Ejemplo

Enviar contenido

Cuerpo de la solicitud

Parámetros

Límites de contenido

Respuesta

Ejemplo: Python

Ejemplo: JavaScript

Ejemplo: Curl

Enviar contenido en bloque

Cuerpo de la solicitud

Parámetros

Respuesta

Botón Crear Grupo de Opiniones

Cuerpo de la solicitud

Parámetros

Respuesta

Crear fuente de datos

Cuerpo de la solicitud

Parámetros

Tipos de pregunta

Respuesta

Publicar fuente de datos

Cuerpo de la solicitud

Respuesta

Webhooks

Ejemplo completo

Soporte