Pular para a documentação

Responses

Itens de texto e função sem estado, com eventos tipados do ciclo de vida da resposta.

Atualizado em 31 de outubro de 2026 · Contrato 0.2.0

POST/v1/responses

Contrato de requisição

Use uma string em input ou itens de entrada tipados com limites, instructions opcionais e max_output_tokens. Este subconjunto não mantém estado: omita storage ou defina store:false. Inclua explicitamente os itens anteriores de texto/função no próximo input.

Correlação de ferramentas

Itens function_call do assistant podem ser enviados de volta com function_call_output usando o call_id correspondente. Preserve cada chamada e seu resultado. Resultados ausentes, duplicados ou sem chamada correspondente são rejeitados.

Ciclo de vida do streaming

Os eventos incluem números de sequência ordenados e eventos nativos de resposta/saída. Uma saída bem-sucedida termina em response.completed. O esgotamento do limite de saída termina em response.incomplete com max_output_tokens; o stream não usa [DONE].

Limite de armazenamento

store:true, previous_response_id, IDs de conversa, execução em segundo plano e semântica nativa de recuperação/exclusão/cancelamento não são compatíveis. store:false desativa a recuperação pública nativa da resposta; isso não apaga os registros persistentes necessários de segurança e contabilidade.

Exemplo de requisição

Use sua chave de cliente e um modelo publicado. Copiar um exemplo não envia uma requisição.

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. Verificações com fixtures são distintas da disponibilidade de modelos ao vivo.

Campos de requisição

Gerado a partir do contrato versionado. As regras de refinamento acima continuam valendo.

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 aceitas
Variante 1string

Até 1.024 caracteres.

Variante 2array<string>

Até 16 itens. Pelo menos 1 item.

response_formatobject | object | object

Mostrar variantes aceitas
Variante 1object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
type"text"obrigatório

Variante 2object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
type"json_object"obrigatório

Variante 3object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
type"json_schema"obrigatório

json_schemaobjectobrigatório

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
namestringobrigatório

descriptionstring

Até 1.000 caracteres.

schemaobjectobrigatório

strictboolean

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

prompt_tokensinteger

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

reasoningobject

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
effort"off" | "none" | "low" | "high" | "max"obrigatório

textobject

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
formatobject | object | object | objectobrigatório

Mostrar variantes aceitas
Variante 1object | object | object

Variante 2object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
type"json_schema"obrigatório

namestringobrigatório

descriptionstring

Até 1.000 caracteres.

schemaobjectobrigatório

strictboolean

modelstringobrigatório

Até 100 caracteres.

inputstring | array<object | object | object>obrigatório

Mostrar variantes aceitas
Variante 1string

Até 1.048.576 caracteres.

Variante 2array<object | object | object>

Até 128 itens. Pelo menos 1 item.

instructionsstring

Até 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>

Até 8 itens.

Mostrar campos do item
type"function"obrigatório

namestringobrigatório

descriptionstring

Até 1.000 caracteres.

parametersobjectobrigatório

strictfalse | null

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

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

Variante 2object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
type"function"obrigatório

namestringobrigatório

Schema da resposta

idstringobrigatório

object"response"obrigatório

created_atintegerobrigatório

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

status"in_progress" | "completed" | "failed" | "incomplete"obrigatório

errorobject | nullobrigatório

Mostrar variantes aceitas
Variante 1object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
codestringobrigatório

messagestringobrigatório

Variante 2null

incomplete_detailsobject | nullobrigatório

Mostrar variantes aceitas
Variante 1object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
reason"max_output_tokens"obrigatório

Variante 2null

instructionsstring | nullobrigatório

max_output_tokensintegerobrigatório

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

modelstringobrigatório

outputarray<object | object | object>obrigatório

parallel_tool_callsbooleanobrigatório

tool_choicestring | objectobrigatório

Mostrar variantes aceitas
Variante 1string

Variante 2object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
type"function"obrigatório

namestringobrigatório

toolsarray<object>obrigatório

Mostrar campos do item
type"function"obrigatório

namestringobrigatório

descriptionstring

Até 1.000 caracteres.

parametersobjectobrigatório

strictfalse | null

usageobject | nullobrigatório

Mostrar variantes aceitas
Variante 1object

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
input_tokensintegerobrigatório

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

input_tokens_detailsobjectobrigatório

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
cached_tokensintegerobrigatório

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

output_tokensintegerobrigatório

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

output_tokens_detailsobject

Campos desconhecidos são rejeitados.

Mostrar campos do objeto
reasoning_tokensintegerobrigatório

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

total_tokensintegerobrigatório

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

Variante 2null

storefalseobrigatório

metadataobjectobrigatório

Campos desconhecidos são rejeitados.

Mostrar campos do objeto