TEXT API (NEW)

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.

max_tokens

number

Número de tokens.

256

messages

array

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

[
    {
      "role": "system",
      "content": "Eres un agente servicial"
    },
    {
      "role": "user",
      "content": "¿Cuál es la capital de Francia?"
    }
  ]

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.95

Parámetros Opcionales

Body

Paámetro
Tipo
Descripción
Ejemplo

stream

bool

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

false

options

list

Define la capacidad máxima de memoria del modelo para recordar tokens (palabras, signos, etc.) en una conversación o entrada.

{
  "num_ctx": 4096,
}

Solicitudes

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

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

Respuestas

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

{
    "id": "chatcmpl-211",
    "object": "chat.completion",
    "created": 1745449715,
    "model": "Saptiva Turbo",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "La capital de México es **Ciudad de México**. 🇲🇽 \n",
                "tool_calls": []
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 22,
        "completion_tokens": 16,
        "total_tokens": 38
    },
    "error": false,
    "status": 200
}

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, 300, 350, 400, 401, 422, 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

curl --location 'https://api.saptiva.com/v1/chat/completions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TU_API_KEY>' \
--data '{
  "model": "Saptiva Turbo",
  "messages": [
    {
      "role": "system",
      "content": "Eres un agente servicial"
    },
    {
      "role": "user",
      "content": "¿Cuál es la capital de Francia?"
    }
  ],
  "max_tokens": 256,
  "temperature": 0.7,
  "top_p": 0.95
}'

Soporte

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

Última actualización