Criar uma resposta do modelo
Use o POST /v1/responses da CometAPI para criar respostas de modelo Multimodal e histórico de conversa com ferramentas integradas e function calling.
gpt-6-astra. Os exemplos também demonstram pesquisa na web, chamadas de função personalizadas, saída estruturada, raciocínio e Streaming.
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 ferramentaweb_search para pesquisar informações e incluir citações de fontes:
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: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
Usetext.format para solicitar JSON que siga um esquema:
Configurar raciocínio
Definareasoning.effort para selecionar o esforço de raciocínio do modelo:
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
Definastream como true para receber eventos enviados pelo servidor:
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
Bearer token authentication. Use your CometAPI key.
Corpo
Model ID to use for this request. See the Models page for current options.
"gpt-6-astra"
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.
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.
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 configuration for this request. Controls how the model manages context when the conversation exceeds the context window.
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.
Additional output data to include in the response. Use this to request extra information that is not included by default.
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 An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.
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.
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.
Whether to allow the model to run tool calls in parallel.
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.
Reference to a prompt template and its variables.
A key used to cache responses for similar requests, helping optimize cache hit rates. Replaces the deprecated user field for caching purposes.
Legacy prompt-cache retention setting. Refer to the selected model documentation for prompt_cache_options and supported retention settings.
in_memory, 24h Reasoning configuration for the selected model.
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.
64Specifies 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.
auto, default, flex, priority Request response storage for later retrieval, when supported by the selected model and request context.
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.
Options for streaming responses. Only set this when stream is true.
Sampling temperature. Omit this field for GPT-6 Astra.
0 <= x <= 2Configuration for text output. Use this to request structured JSON output via JSON mode or JSON Schema.
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 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.
Number of token alternatives to include for models supporting log probabilities. Requires message.output_text.logprobs in include. Omit for GPT-6 Astra.
0 <= x <= 20Nucleus sampling threshold. Omit this field for GPT-6 Astra. For sampling overrides, adjust either top_p or temperature.
0 <= x <= 1The 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.
auto, disabled Deprecated. Use safety_identifier and prompt_cache_key instead. A stable identifier for your end-user.
Resposta
The generated Response object.
Unique identifier for the response.
"resp_example"
The object type, always response.
response "response"
Unix timestamp (in seconds) of when the response was created.
1788763707
The status of the response.
completed, in_progress, failed, cancelled, queued, incomplete "completed"
Whether the response was run in the background.
false
Unix timestamp of when the response was completed, or null if still in progress.
1788763711
Error information if the response failed, or null on success.
Details about why the response is incomplete, if applicable.
The system instructions used for this response.
The maximum output token limit that was applied.
The model used for the response.
"gpt-6-astra"
An array of output items generated by the model. Each item can be a message, function call, or other output type.
Whether parallel tool calls were enabled.
The ID of the previous response, if this is a multi-turn conversation.
The reasoning configuration that was used.
The service tier actually used to process the request.
Whether the response was stored.
The temperature value used.
The text configuration used.
The tool choice setting used.
The tools that were available for this response.
The top_p value used.
The truncation strategy used.
Token usage statistics for this response.
The user identifier, if provided.
The metadata attached to this response.
Content filter results applied to the response, if any.
The frequency penalty applied to the request.
Maximum number of tool calls allowed, if set.
The presence penalty applied to the request.
Cache key for prompt caching, if applicable.
Prompt cache retention policy, if applicable.
Safety system identifier for the response, if applicable.
Number of top log probabilities returned per token position.