API Reference

Procesamiento de respuestas

URL: https://api.saptiva.com/v1/chat/completions

POST /

Headers

Nombre
Valor

Content-Type

application/json

Authorization

Bearer <API_KEY>

Nuestra API requiere autenticación utilizando un Token Bearer. Genera tu token dentro de nuestro lab y comienza a hacer peticiones. Incluye el token en el header de la solicitud de la siguiente manera:

Authorization: Bearer <TOKEN AUTHORIZATION>


Parámetros Obligatorios

Body

Parametro
Tipo
Descripción
Ejemplo

model

string

Nombre del modelo LLM a usar.

Saptiva Cortex

messages

array

Lista (o array) de objetos que representan un historial de conversación entre un sistema y un usuario.


Parámetros Opcionales

Body

Parámetro
Tipo
Descripción
Valores por Defecto

max_tokens

number

Número de tokens.

600

temperature

double

Grado de aleatoriedad en la generación del texto. (valor entre 0.0 y 1.0)

0.7

top_p

double

Limite de diversidad del conjunto de palabras consideradas. (valor entre 0.0 y 1.0)

0.9

stream

bool

Indica si la respuesta del modelo debe ser enviada por partes (streaming) o completa de una vez.

false

tools

List[ToolItem]

Define una lista de tools a usar. Para más información, consulta Tools.

null

prompt

string

Texto que se busca transformar en un embedding

null


Solicitudes (Modelos Texto-Texto)

A continuación, se presenta el formato que debe tener el BODY, junto con el ejemplo de la respuesta esperada.

Modelos:

{
  "model": "Saptiva Turbo",
  "messages": [
    {
      "role": "system",
      "content": "Eres un agente servicial"
    },
    {
      "role": "user",
      "content": "¿Cuál es la capital de México?"
    }
  ],
  "max_tokens": 256,
  "temperature": 0.7,
  "top_p": 0.95
}

Solicitudes (Modelo de Razonamiento)

A continuación, se presenta el formato que debe tener el BODY, junto con el ejemplo de la respuesta esperada.

Modelo:


Solicitudes (Modelo OCR)

A continuación, se presenta el formato que debe tener el BODY, junto con el ejemplo de la respuesta esperada.

En el campo url, proporcione la imagen en uno de los siguientes formatos:

  • URL de descarga accesible públicamente,

  • Cadena base64 con formato: data:image/png;base64,<BASE64_DE_LA_IMAGEN>

  • Nota: Las instrucciones deben enviarse como text dentro del mensaje del usuario, no como mensaje de sistema.

  • Tokens totales (input + output): 8,192

  • Tamaño máximo de la solicitud: 50 MB

  • Dejar 1 MB libre en cada solicitud

  • Resolución recomendada: 150–200 DPI para documentos sencillos; 300 DPI para imágenes con detalles pequeños.

Modelo:


Solicitudes (Modelo Embedding)

A continuación, se presenta el formato que debe tener el BODY, junto con el ejemplo de la respuesta esperada.

URL : https://api.saptiva.com/api/embed

POST /

Modelo:


Respuestas

A continuación, se muestra un ejemplo de una respuesta exitosa y una de error.


Errores

Para analizar y solucionar los errores a los que te puedes enfrentar al hacer uso de esta API, consulta nuestros códigos de errores junto con las soluciones que tenemos para ti.

Mejores Prácticas

  • Proteja las credenciales: Nunca exponga tu API Key o tokens de autenticación en el código del lado del cliente. Utiliza variables de entorno o un backend seguro para manejar credenciales.

  • Use HTTPS: Siempre realice solicitudes a la API a través de HTTPS para proteger la transmisión de datos.

  • Verifique las respuestas de la API: Siempre maneje los códigos de estado HTTP correctamente (200, 400, 401, 422, 500, etc.).

  • Gestione los tiempos de espera (timeouts): Establezca límites de tiempo adecuados para evitar que la aplicación se quede bloqueada en solicitudes prolongadas.


Ejemplos


Soporte

Para cualquier problema o pregunta técnica, comuníquese con el equipo de desarrollo.

Última actualización