IA

Preguntar a la IA sobre tus datos

Responde en lenguaje natural a una pregunta sobre los datos de tu cuenta, y opcionalmente también busca en la web.

POST
/api/v1/ai/ask

Ejemplos de petición

curl https://app.filmo.io/api/v1/ai/ask \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "question": "¿Qué pedidos tengo confirmados la semana que viene y qué material sale en ellos?",
  "webSearch": false,
  "mode": "instant"
}'
{
  "data": {
    "answer": "Example answer",
    "needsMoreContext": true,
    "webSearchSources": [
      {
        "url": "https://example.com/resource",
        "title": "Example title",
        "favicon": "Example favicon"
      }
    ]
  }
}

Generado a partir del esquema

NUNCA escribe nada: el motor se ejecuta sin ninguna herramienta de escritura cargada, y lo que puede leer está acotado por la barrera de permisos del propietario de la clave de API, tabla por tabla. Consume créditos de IA de la cuenta: sin cuota responde 402 addon_required sin llegar a consultar al modelo. Puede tardar decenas de segundos en preguntas que encadenan varias consultas; si needsMoreContext pasa a true, la respuesta viene vacía y debes reformular con más detalle en lugar de reintentar lo mismo.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. ai:ask

Cuerpo

application/json

Esquema del cuerpo: AiAskBody

questionstringObligatorio

Pregunta en lenguaje natural sobre los datos de tu cuenta. Obligatoria.

Límites: longitud mín. 1, longitud máx. 4000

webSearchbooleanpredeterminado:false

Permite también buscar en la web para responder. Por defecto es false: solo se consultan los datos de la cuenta.

modestringpredeterminado:"instant"

Modo de respuesta. Hoy solo "instant" (una sola pasada, sin conversación). Se documenta para que los modos futuros sean aditivos.

Opciones disponibles: instant

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: AiAskDto

Sobre: AiAskResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

El ai ask, tal como lo devuelve la API.

Mostrar atributos hijos
data.answerstring

Respuesta en markdown. Cadena vacía cuando needsMoreContext es true.

data.needsMoreContextboolean

True cuando la IA terminó sin poder responder y necesita más contexto. En ese caso answer viene vacío: reformula la pregunta con más detalle en lugar de reintentarla tal cual.

data.webSearchSourcesobject[]

Fuentes web citadas. Vacío si no se pidió búsqueda web o si no se usó ninguna.

Mostrar atributos hijos
data.webSearchSources.urlstring

URL de la fuente consultada.

data.webSearchSources.titlestring

Título de origen.

data.webSearchSources.faviconstring

URL del favicon del sitio, para mostrar la fuente.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
402addon_requiredEl plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

¿Te ha resultado útil esta página?