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
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 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"temperaturenumberMínimo de 0. Máximo de 2.
top_pnumberMínimo de 0. Máximo de 1.
stopstring | array<string>Mostrar variantes aceitas
Variante 1stringAté 1.024 caracteres.
Variante 2array<string>Até 16 itens. Pelo menos 1 item.
response_formatobject | object | objectMostrar variantes aceitas
Variante 1objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
type"text"obrigatórioVariante 2objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
type"json_object"obrigatórioVariante 3objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
type"json_schema"obrigatóriojson_schemaobjectobrigatórioCampos desconhecidos são rejeitados.
Mostrar campos do objeto
namestringobrigatóriodescriptionstringAté 1.000 caracteres.
schemaobjectobrigatóriostrictbooleaneffort"off" | "none" | "low" | "high" | "max"prompt_tokensintegerMínimo de 0. Máximo de 9.007.199.254.740.991.
reasoningobjectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
effort"off" | "none" | "low" | "high" | "max"obrigatóriotextobjectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
formatobject | object | object | objectobrigatórioMostrar variantes aceitas
Variante 1object | object | objectVariante 2objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
type"json_schema"obrigatórionamestringobrigatóriodescriptionstringAté 1.000 caracteres.
schemaobjectobrigatóriostrictbooleanmodelstringobrigatórioAté 100 caracteres.
inputstring | array<object | object | object>obrigatórioMostrar variantes aceitas
Variante 1stringAté 1.048.576 caracteres.
Variante 2array<object | object | object>Até 128 itens. Pelo menos 1 item.
instructionsstringAté 1.048.576 caracteres.
max_output_tokensintegerMínimo de 1. Máximo de 512.000.
max_tokensintegerMínimo de 1. Máximo de 512.000.
max_completion_tokensintegerMínimo de 1. Máximo de 512.000.
streambooleanstorefalsebackgroundfalsetoolsarray<object>Até 8 itens.
Mostrar campos do item
type"function"obrigatórionamestringobrigatóriodescriptionstringAté 1.000 caracteres.
parametersobjectobrigatóriostrictfalse | nulltool_choice"auto" | "none" | "required" | objectMostrar variantes aceitas
Variante 1"auto" | "none" | "required"Variante 2objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
type"function"obrigatórionamestringobrigatórioSchema da resposta
idstringobrigatórioobject"response"obrigatóriocreated_atintegerobrigatórioMínimo de -9.007.199.254.740.991. Máximo de 9.007.199.254.740.991.
status"in_progress" | "completed" | "failed" | "incomplete"obrigatórioerrorobject | nullobrigatórioMostrar variantes aceitas
Variante 1objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
codestringobrigatóriomessagestringobrigatórioVariante 2nullincomplete_detailsobject | nullobrigatórioMostrar variantes aceitas
Variante 1objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
reason"max_output_tokens"obrigatórioVariante 2nullinstructionsstring | nullobrigatóriomax_output_tokensintegerobrigatórioMínimo de -9.007.199.254.740.991. Máximo de 9.007.199.254.740.991.
modelstringobrigatóriooutputarray<object | object | object>obrigatórioparallel_tool_callsbooleanobrigatóriotool_choicestring | objectobrigatórioMostrar variantes aceitas
Variante 1stringVariante 2objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
type"function"obrigatórionamestringobrigatóriotoolsarray<object>obrigatórioMostrar campos do item
type"function"obrigatórionamestringobrigatóriodescriptionstringAté 1.000 caracteres.
parametersobjectobrigatóriostrictfalse | nullusageobject | nullobrigatórioMostrar variantes aceitas
Variante 1objectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
input_tokensintegerobrigatórioMínimo de 0. Máximo de 9.007.199.254.740.991.
input_tokens_detailsobjectobrigatórioCampos desconhecidos são rejeitados.
Mostrar campos do objeto
cached_tokensintegerobrigatórioMínimo de 0. Máximo de 9.007.199.254.740.991.
output_tokensintegerobrigatórioMínimo de 0. Máximo de 9.007.199.254.740.991.
output_tokens_detailsobjectCampos desconhecidos são rejeitados.
Mostrar campos do objeto
reasoning_tokensintegerobrigatórioMínimo de 0. Máximo de 9.007.199.254.740.991.
total_tokensintegerobrigatórioMínimo de 0. Máximo de 9.007.199.254.740.991.
Variante 2nullstorefalseobrigatóriometadataobjectobrigatórioCampos desconhecidos são rejeitados.