Skip to main content
POST
Use a API Responses para enviar texto, imagens, arquivos e histórico de conversa com gpt-6-astra. Os exemplos também demonstram pesquisa na web, chamadas de função personalizadas, saída estruturada, raciocínio e Streaming.
A referência de Responses da OpenAI descreve o formato completo da API; os exemplos aqui configuram esse formato para a CometAPI.

Continuar uma conversa

Para uma conversa somente de texto, mantenha as mensagens do usuário e as respostas de texto do assistente e, em seguida, adicione a próxima mensagem do usuário:
response.output_text é uma propriedade de conveniência do SDK que combina o texto do assistente da resposta. Conversas com Function Calling também precisam dos itens de chamada de ferramenta e de resultado, conforme descrito abaixo.

Usar pesquisa na web

Adicione uma ferramenta web_search para pesquisar informações e incluir citações de fontes:
Examine os itens retornados web_search_call e as anotações de URL da mensagem quando seu aplicativo precisar de resultados de pesquisa ou citações. Outras ferramentas integradas exigem sua própria configuração; consulte o guia de ferramentas da OpenAI.

Chamar funções personalizadas

Defina os argumentos da função e deixe o modelo solicitar a função:
Uma chamada de função aparece como um item de saída function_call. Seu campo arguments é uma string codificada em JSON. Execute sua função e, em seguida, crie a próxima solicitação a partir da entrada original e dos itens de saída retornados, sem os campos id dos itens de resposta. Mantenha os valores name, arguments e call_id da função e acrescente um item function_call_output com o call_id correspondente e seu resultado em output.

Solicitar saída estruturada

Use text.format para solicitar JSON que siga um esquema:
Verifique se a resposta foi concluída e não recusou a solicitação antes de analisar o JSON. Uma resposta que atinge seu limite de Tokens de saída pode estar incompleta.

Configurar raciocínio

Defina reasoning.effort para selecionar o esforço de raciocínio do modelo:
Os exemplos usam low para tarefas gerais e high para o exemplo de raciocínio. max_output_tokens inclui Tokens de raciocínio e Tokens de saída visíveis.

Transmitir respostas

Defina stream como true para receber eventos enviados pelo servidor:
Uma resposta de texto inclui eventos de ciclo de vida, como response.created, response.in_progress e response.completed. O texto chega em eventos response.output_text.delta. Os eventos de ferramentas e de raciocínio dependem da solicitação; portanto, processe os eventos pelo respectivo type em vez de presumir que todas as respostas têm a mesma sequência.

Autorizações

Authorization
string
header
obrigatório

Bearer token authentication. Use your CometAPI key.

Corpo

application/json
model
string
padrão:gpt-6-astra
obrigatório

Model ID to use for this request. See the Models page for current options.

Exemplo:

"gpt-6-astra"

input
obrigatório

Text, image, or file inputs to the model, used to generate a response. Can be a simple string for text-only input, or an array of input items for multimodal content (images, files) and multi-turn conversations.

instructions
string

A system (or developer) message inserted into the model's context. When used with previous_response_id, instructions from the previous response are not carried over — this makes it easy to swap system messages between turns.

background
boolean

Whether to run the model response in the background. Background responses do not return output directly — you retrieve the result later via the response ID.

context_management
object[]

Context management configuration for this request. Controls how the model manages context when the conversation exceeds the context window.

conversation

The conversation this response belongs to. Items from the conversation are prepended to input for context. Input and output items are automatically added to the conversation after the response completes. Cannot be used with previous_response_id.

include
enum<string>[]

Additional output data to include in the response. Use this to request extra information that is not included by default.

Opções disponíveis:
web_search_call.action.sources,
code_interpreter_call.outputs,
computer_call_output.output.image_url,
file_search_call.results,
message.input_image.image_url,
message.output_text.logprobs,
reasoning.encrypted_content
max_output_tokens
integer

An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.

max_tool_calls
integer

The maximum number of total calls to built-in tools that can be processed in a response. This limit applies across all built-in tool calls, not per individual tool. Any further tool call attempts by the model will be ignored.

metadata
object

Set of up to 16 key-value pairs that can be attached to the response. Useful for storing additional information in a structured format. Keys have a maximum length of 64 characters; values have a maximum length of 512 characters.

parallel_tool_calls
boolean

Whether to allow the model to run tool calls in parallel.

previous_response_id
string

An ID for a stored response that is accessible to the selected model and request context. Cannot be combined with conversation. The conversation-history example sends prior input and output items explicitly.

prompt
object

Reference to a prompt template and its variables.

prompt_cache_key
string

A key used to cache responses for similar requests, helping optimize cache hit rates. Replaces the deprecated user field for caching purposes.

prompt_cache_retention
enum<string>
obsoleto

Legacy prompt-cache retention setting. Refer to the selected model documentation for prompt_cache_options and supported retention settings.

Opções disponíveis:
in_memory,
24h
reasoning
object

Reasoning configuration for the selected model.

safety_identifier
string

A stable identifier for your end-users, used to help detect policy violations. Should be a hashed username or email — do not send identifying information directly.

Maximum string length: 64
service_tier
enum<string>

Specifies the processing tier for the request. When set, the response will include the actual service_tier used.

  • auto: Uses the tier configured in project settings (default behavior).
  • default: Standard pricing and performance.
  • flex: Flexible processing with potential cost savings.
  • priority: Priority processing with faster response times.
Opções disponíveis:
auto,
default,
flex,
priority
store
boolean

Request response storage for later retrieval, when supported by the selected model and request context.

stream
boolean

If set to true, the response data will be streamed to the client as it is generated using server-sent events (SSE). Events include response.created, response.output_text.delta, response.completed, and more.

stream_options
object

Options for streaming responses. Only set this when stream is true.

temperature
number

Sampling temperature. Omit this field for GPT-6 Astra.

Intervalo necessário: 0 <= x <= 2
text
object

Configuration for text output. Use this to request structured JSON output via JSON mode or JSON Schema.

tool_choice

Controls how the model selects which tool(s) to call.

  • auto (default): The model decides whether and which tools to call.
  • none: The model will not call any tools.
  • required: The model must call at least one tool.
  • An object specifying a particular tool to use.
tools
object[]

Tools available to the model. This page demonstrates web_search and custom function tools. Other tool types require their own configuration; see the official tool reference.

top_logprobs
integer

Number of token alternatives to include for models supporting log probabilities. Requires message.output_text.logprobs in include. Omit for GPT-6 Astra.

Intervalo necessário: 0 <= x <= 20
top_p
number

Nucleus sampling threshold. Omit this field for GPT-6 Astra. For sampling overrides, adjust either top_p or temperature.

Intervalo necessário: 0 <= x <= 1
truncation
enum<string>

The truncation strategy for handling inputs that exceed the model's context window.

  • auto: The model truncates the input by dropping items from the beginning of the conversation to fit.
  • disabled (default): The request fails with a 400 error if the input exceeds the context window.
Opções disponíveis:
auto,
disabled
user
string
obsoleto

Deprecated. Use safety_identifier and prompt_cache_key instead. A stable identifier for your end-user.

Resposta

200 - application/json

The generated Response object.

id
string

Unique identifier for the response.

Exemplo:

"resp_example"

object
enum<string>

The object type, always response.

Opções disponíveis:
response
Exemplo:

"response"

created_at
integer

Unix timestamp (in seconds) of when the response was created.

Exemplo:

1788763707

status
enum<string>

The status of the response.

Opções disponíveis:
completed,
in_progress,
failed,
cancelled,
queued,
incomplete
Exemplo:

"completed"

background
boolean

Whether the response was run in the background.

Exemplo:

false

completed_at
integer | null

Unix timestamp of when the response was completed, or null if still in progress.

Exemplo:

1788763711

error
object | null

Error information if the response failed, or null on success.

incomplete_details
object | null

Details about why the response is incomplete, if applicable.

instructions
string | null

The system instructions used for this response.

max_output_tokens
integer | null

The maximum output token limit that was applied.

model
string

The model used for the response.

Exemplo:

"gpt-6-astra"

output
object[]

An array of output items generated by the model. Each item can be a message, function call, or other output type.

parallel_tool_calls
boolean

Whether parallel tool calls were enabled.

previous_response_id
string | null

The ID of the previous response, if this is a multi-turn conversation.

reasoning
object

The reasoning configuration that was used.

service_tier
string

The service tier actually used to process the request.

store
boolean

Whether the response was stored.

temperature
number

The temperature value used.

text
object

The text configuration used.

tool_choice

The tool choice setting used.

tools
object[]

The tools that were available for this response.

top_p
number

The top_p value used.

truncation
string

The truncation strategy used.

usage
object

Token usage statistics for this response.

user
string | null

The user identifier, if provided.

metadata
object

The metadata attached to this response.

content_filters
array | null

Content filter results applied to the response, if any.

frequency_penalty
number

The frequency penalty applied to the request.

max_tool_calls
integer | null

Maximum number of tool calls allowed, if set.

presence_penalty
number

The presence penalty applied to the request.

prompt_cache_key
string | null

Cache key for prompt caching, if applicable.

prompt_cache_retention
string | null

Prompt cache retention policy, if applicable.

safety_identifier
string | null

Safety system identifier for the response, if applicable.

top_logprobs
integer

Number of top log probabilities returned per token position.

Última modificação em 8 de setembro de 2026