Saltar a la documentación

Responses

Elementos de texto y función sin estado, con eventos tipados del ciclo de vida de la respuesta.

Actualizado el 31 de octubre de 2026 · Contrato 0.2.0

POST/v1/responses

Contrato de solicitud

Usa una cadena en input o elementos de entrada tipados con límites, instructions opcionales y max_output_tokens. Este subconjunto no mantiene estado: omite storage o define store:false. Incluye de forma explícita los elementos anteriores de texto/función en el siguiente input.

Correlación de herramientas

Los elementos function_call de assistant pueden enviarse de vuelta con function_call_output usando el call_id correspondiente. Conserva cada llamada y su resultado. Se rechazan los resultados ausentes, duplicados o sin llamada correspondiente.

Ciclo de vida del streaming

Los eventos incluyen números de secuencia ordenados y eventos nativos de respuesta/salida. Una salida correcta termina en response.completed. El agotamiento del límite de salida termina en response.incomplete con max_output_tokens; el stream no usa [DONE].

Límite de almacenamiento

store:true, previous_response_id, los ID de conversación, la ejecución en segundo plano y la semántica nativa de recuperación/eliminación/cancelación no son compatibles. store:false desactiva la recuperación pública nativa de la respuesta; no borra los registros persistentes necesarios de seguridad y contabilidad.

Ejemplo de solicitud

Usa tu clave de cliente y un modelo publicado. Copiar un ejemplo no envía una solicitud.

curl
curl https://api.notholy.com/v1/responses \
  -H "Authorization: Bearer $NOTHOLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "notholy-pulse",
  "input": "Explain least privilege.",
  "max_output_tokens": 256,
  "store": false
}'

Fixture de contrato HTTP. Las comprobaciones con fixtures son distintas de la disponibilidad de modelos en vivo.

Campos de solicitud

Generado a partir del contrato versionado. Las reglas de refinamiento anteriores siguen aplicándose.

reasoning_effort"off" | "none" | "low" | "high" | "max"

temperaturenumber

Mínimo de 0. Máximo de 2.

top_pnumber

Mínimo de 0. Máximo de 1.

stopstring | array<string>

Mostrar variantes aceptadas
Variante 1string

Hasta 1024 caracteres.

Variante 2array<string>

Hasta 16 elementos. Al menos 1 elemento.

response_formatobject | object | object

Mostrar variantes aceptadas
Variante 1object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
type"text"obligatorio

Variante 2object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
type"json_object"obligatorio

Variante 3object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
type"json_schema"obligatorio

json_schemaobjectobligatorio

Se rechazan los campos desconocidos.

Mostrar campos del objeto
namestringobligatorio

descriptionstring

Hasta 1000 caracteres.

schemaobjectobligatorio

strictboolean

effort"off" | "none" | "low" | "high" | "max"

prompt_tokensinteger

Mínimo de 0. Máximo de 9.007.199.254.740.991.

reasoningobject

Se rechazan los campos desconocidos.

Mostrar campos del objeto
effort"off" | "none" | "low" | "high" | "max"obligatorio

textobject

Se rechazan los campos desconocidos.

Mostrar campos del objeto
formatobject | object | object | objectobligatorio

Mostrar variantes aceptadas
Variante 1object | object | object

Variante 2object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
type"json_schema"obligatorio

namestringobligatorio

descriptionstring

Hasta 1000 caracteres.

schemaobjectobligatorio

strictboolean

modelstringobligatorio

Hasta 100 caracteres.

inputstring | array<object | object | object>obligatorio

Mostrar variantes aceptadas
Variante 1string

Hasta 1.048.576 caracteres.

Variante 2array<object | object | object>

Hasta 128 elementos. Al menos 1 elemento.

instructionsstring

Hasta 1.048.576 caracteres.

max_output_tokensinteger

Mínimo de 1. Máximo de 512.000.

max_tokensinteger

Mínimo de 1. Máximo de 512.000.

max_completion_tokensinteger

Mínimo de 1. Máximo de 512.000.

streamboolean

storefalse

backgroundfalse

toolsarray<object>

Hasta 8 elementos.

Mostrar campos del elemento
type"function"obligatorio

namestringobligatorio

descriptionstring

Hasta 1000 caracteres.

parametersobjectobligatorio

strictfalse | null

tool_choice"auto" | "none" | "required" | object

Mostrar variantes aceptadas
Variante 1"auto" | "none" | "required"

Variante 2object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
type"function"obligatorio

namestringobligatorio

Esquema de respuesta

idstringobligatorio

object"response"obligatorio

created_atintegerobligatorio

Mínimo de -9.007.199.254.740.991. Máximo de 9.007.199.254.740.991.

status"in_progress" | "completed" | "failed" | "incomplete"obligatorio

errorobject | nullobligatorio

Mostrar variantes aceptadas
Variante 1object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
codestringobligatorio

messagestringobligatorio

Variante 2null

incomplete_detailsobject | nullobligatorio

Mostrar variantes aceptadas
Variante 1object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
reason"max_output_tokens"obligatorio

Variante 2null

instructionsstring | nullobligatorio

max_output_tokensintegerobligatorio

Mínimo de -9.007.199.254.740.991. Máximo de 9.007.199.254.740.991.

modelstringobligatorio

outputarray<object | object | object>obligatorio

parallel_tool_callsbooleanobligatorio

tool_choicestring | objectobligatorio

Mostrar variantes aceptadas
Variante 1string

Variante 2object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
type"function"obligatorio

namestringobligatorio

toolsarray<object>obligatorio

Mostrar campos del elemento
type"function"obligatorio

namestringobligatorio

descriptionstring

Hasta 1000 caracteres.

parametersobjectobligatorio

strictfalse | null

usageobject | nullobligatorio

Mostrar variantes aceptadas
Variante 1object

Se rechazan los campos desconocidos.

Mostrar campos del objeto
input_tokensintegerobligatorio

Mínimo de 0. Máximo de 9.007.199.254.740.991.

input_tokens_detailsobjectobligatorio

Se rechazan los campos desconocidos.

Mostrar campos del objeto
cached_tokensintegerobligatorio

Mínimo de 0. Máximo de 9.007.199.254.740.991.

output_tokensintegerobligatorio

Mínimo de 0. Máximo de 9.007.199.254.740.991.

output_tokens_detailsobject

Se rechazan los campos desconocidos.

Mostrar campos del objeto
reasoning_tokensintegerobligatorio

Mínimo de 0. Máximo de 9.007.199.254.740.991.

total_tokensintegerobligatorio

Mínimo de 0. Máximo de 9.007.199.254.740.991.

Variante 2null

storefalseobligatorio

metadataobjectobligatorio

Se rechazan los campos desconocidos.

Mostrar campos del objeto