Python 88.3%
TypeScript 7.6%
Shell 4.1%
1{2 "_generated_by": "tmp/openai-core/build_fragments.py (agent openai-core)",3 "_generated_at": "2026-09-18",4 "_notation": "dotted paths; [] = array element; (x) = union member discriminated by type/role (e.g. input[](message).content[](input_image).detail); tools[] internals owned by tools fragments",5 "records": [6 {7 "provider": "openai",8 "object": "Response",9 "type_or_object_value": "object = \"response\"",10 "description": "The Response object returned by POST/GET /v1/responses (also inside response.* events).",11 "fields": [12 {13 "field": "metadata",14 "type": "map<string,string>",15 "required": true,16 "enum": null,17 "default": null,18 "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters."19 },20 {21 "field": "top_logprobs",22 "type": "integer | null",23 "required": false,24 "enum": null,25 "default": null,26 "description": "An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested."27 },28 {29 "field": "temperature",30 "type": "number | null",31 "required": true,32 "enum": null,33 "default": 1,34 "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both."35 },36 {37 "field": "top_p",38 "type": "number | null",39 "required": true,40 "enum": null,41 "default": 1,42 "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both."43 },44 {45 "field": "user",46 "type": "string",47 "required": false,48 "enum": null,49 "default": null,50 "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifi",51 "deprecated": true52 },53 {54 "field": "safety_identifier",55 "type": "string | null",56 "required": false,57 "enum": null,58 "default": null,59 "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-p"60 },61 {62 "field": "prompt_cache_key",63 "type": "string | null",64 "required": false,65 "enum": null,66 "default": null,67 "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching)."68 },69 {70 "field": "prompt_cache_retention",71 "type": "string | null",72 "required": false,73 "enum": [74 "in_memory",75 "24h"76 ],77 "default": null,78 "description": "Deprecated. Use `prompt_cache_options.ttl` instead. The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). This field expresses a maximum retention policy, while `prompt_cache_options.ttl` ",79 "deprecated": true80 },81 {82 "field": "previous_response_id",83 "type": "string | null",84 "required": false,85 "enum": null,86 "default": null,87 "description": "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`."88 },89 {90 "field": "model",91 "type": "string",92 "required": true,93 "enum": null,94 "default": null,95 "description": "Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models."96 },97 {98 "field": "background",99 "type": "boolean | null",100 "required": false,101 "enum": null,102 "default": false,103 "description": "Whether to run the model response in the background. [Learn more](https://developers.openai.com/api/docs/guides/background)."104 },105 {106 "field": "max_tool_calls",107 "type": "integer | null",108 "required": false,109 "enum": null,110 "default": null,111 "description": "The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored."112 },113 {114 "field": "text",115 "type": "object",116 "required": false,117 "enum": null,118 "default": null,119 "description": "Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)"120 },121 {122 "field": "text.format",123 "type": "object<text> | object<json_schema> | object<json_object>",124 "required": false,125 "enum": null,126 "default": null,127 "description": "An object specifying the format that the model must output. Configuring `{ \"type\": \"json_schema\" }` enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). The default format is `{ \"type\": \"text\" }` with no additional options. **Not recommended for gpt-4"128 },129 {130 "field": "text.verbosity",131 "type": "string | null",132 "required": false,133 "enum": [134 "low",135 "medium",136 "high"137 ],138 "default": "medium",139 "description": "Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. The default is `medium`."140 },141 {142 "field": "prompt",143 "type": "object | null",144 "required": false,145 "enum": null,146 "default": null,147 "description": "Reference to a prompt template and its variables. [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code)."148 },149 {150 "field": "prompt.id",151 "type": "string",152 "required": true,153 "enum": null,154 "default": null,155 "description": "The unique identifier of the prompt template to use."156 },157 {158 "field": "prompt.version",159 "type": "string | null",160 "required": false,161 "enum": null,162 "default": null,163 "description": "Optional version of the prompt template."164 },165 {166 "field": "prompt.variables",167 "type": "map<string,string | object<input_text> | object<input_image> | object<input_file>>",168 "required": false,169 "enum": null,170 "default": null,171 "description": "Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files."172 },173 {174 "field": "service_tier",175 "type": "string | null",176 "required": false,177 "enum": [178 "auto",179 "default",180 "flex",181 "scale",182 "priority",183 "fast",184 "ultrafast"185 ],186 "default": "auto",187 "description": "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.ope"188 },189 {190 "field": "truncation",191 "type": "string | null",192 "required": false,193 "enum": [194 "auto",195 "disabled"196 ],197 "default": "disabled",198 "description": "The truncation strategy to use for the model response. - `auto`: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation. - `disabled` (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error."199 },200 {201 "field": "id",202 "type": "string",203 "required": true,204 "enum": null,205 "default": null,206 "description": "Unique identifier for this Response."207 },208 {209 "field": "object",210 "type": "string",211 "required": true,212 "enum": [213 "response"214 ],215 "default": null,216 "description": "The object type of this resource - always set to `response`."217 },218 {219 "field": "status",220 "type": "string",221 "required": false,222 "enum": [223 "completed",224 "failed",225 "in_progress",226 "cancelled",227 "queued",228 "incomplete"229 ],230 "default": null,231 "description": "The status of the response generation. One of `completed`, `failed`, `in_progress`, `cancelled`, `queued`, or `incomplete`."232 },233 {234 "field": "created_at",235 "type": "number",236 "required": true,237 "enum": null,238 "default": null,239 "description": "Unix timestamp (in seconds) of when this Response was created."240 },241 {242 "field": "completed_at",243 "type": "number | null",244 "required": false,245 "enum": null,246 "default": null,247 "description": "Unix timestamp (in seconds) of when this Response was completed. Only present when the status is `completed`."248 },249 {250 "field": "error",251 "type": "object | null",252 "required": true,253 "enum": null,254 "default": null,255 "description": "An error object returned when the model fails to generate a Response."256 },257 {258 "field": "error.code",259 "type": "string",260 "required": true,261 "enum": [262 "server_error",263 "rate_limit_exceeded",264 "invalid_prompt",265 "data_residency_mismatch",266 "bio_policy",267 "misalignment_policy_violation",268 "vector_store_timeout",269 "invalid_image",270 "invalid_image_format",271 "invalid_base64_image",272 "invalid_image_url",273 "image_too_large",274 "image_too_small",275 "image_parse_error",276 "image_content_policy_violation",277 "invalid_image_mode",278 "image_file_too_large",279 "unsupported_image_media_type",280 "empty_image_file",281 "failed_to_download_image",282 "image_file_not_found"283 ],284 "default": null,285 "description": "The error code for the response."286 },287 {288 "field": "error.message",289 "type": "string",290 "required": true,291 "enum": null,292 "default": null,293 "description": "A human-readable description of the error."294 },295 {296 "field": "error.misalignment",297 "type": "object",298 "required": false,299 "enum": null,300 "default": null,301 "description": ""302 },303 {304 "field": "incomplete_details",305 "type": "object | null",306 "required": true,307 "enum": null,308 "default": null,309 "description": "Details about why the response is incomplete."310 },311 {312 "field": "incomplete_details.reason",313 "type": "string",314 "required": false,315 "enum": [316 "max_output_tokens",317 "max_messages",318 "content_filter",319 "steered"320 ],321 "default": null,322 "description": "The reason why the response is incomplete. `steered` means the response stopped at a safe output boundary after a WebSocket `response.steer` event. The server can then create a successor response automatically with the queued input."323 },324 {325 "field": "output",326 "type": "array<object<message> | object<file_search_call> | object<function_call> | object<function_call_output> | object<web_search_call> | object<computer_call> | object<computer_call_output> | object<reasoning> | object<program> | object<program_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_call> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<custom_tool_call> | object<custom_tool_call_output>>",327 "required": true,328 "enum": null,329 "default": null,330 "description": "An array of content items generated by the model. - The length and order of items in the `output` array is dependent on the model's response. - Rather than accessing the first item in the `output` array and assuming it's an `assistant` message with the content generated by the model, you might consider using the `output_text` property where supported in SDKs."331 },332 {333 "field": "reasoning",334 "type": "object | null",335 "required": false,336 "enum": null,337 "default": null,338 "description": "Configuration options for [reasoning models](https://developers.openai.com/api/docs/guides/reasoning)."339 },340 {341 "field": "reasoning.mode",342 "type": "string",343 "required": false,344 "enum": null,345 "default": null,346 "description": "Controls the reasoning execution mode for the request. When returned on a response, this is the effective execution mode."347 },348 {349 "field": "reasoning.effort",350 "type": "string | null",351 "required": false,352 "enum": [353 "none",354 "minimal",355 "low",356 "medium",357 "high",358 "xhigh",359 "max"360 ],361 "default": "medium",362 "description": "Constrains effort on reasoning for reasoning models. Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for model-specif"363 },364 {365 "field": "reasoning.summary",366 "type": "string | null",367 "required": false,368 "enum": [369 "auto",370 "concise",371 "detailed"372 ],373 "default": null,374 "description": "A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`. `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`."375 },376 {377 "field": "reasoning.context",378 "type": "string | null",379 "required": false,380 "enum": [381 "auto",382 "current_turn",383 "all_turns"384 ],385 "default": null,386 "description": "Controls which reasoning items are rendered back to the model on later turns. If omitted or set to `auto`, the model determines the context mode. The `gpt-5.6` model family defaults to `all_turns`; earlier models default to `current_turn`. When returned on a response, this is the effective reasoning context mode used for the response."387 },388 {389 "field": "reasoning.generate_summary",390 "type": "string | null",391 "required": false,392 "enum": [393 "auto",394 "concise",395 "detailed"396 ],397 "default": null,398 "description": "**Deprecated:** use `summary` instead. A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`.",399 "deprecated": true400 },401 {402 "field": "instructions",403 "type": "string | array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>>",404 "required": true,405 "enum": null,406 "default": null,407 "description": "A system (or developer) message inserted into the model's context. When using along with `previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses."408 },409 {410 "field": "output_text",411 "type": "string | null",412 "required": false,413 "enum": null,414 "default": null,415 "description": "SDK-only convenience property that contains the aggregated text output from all `output_text` items in the `output` array, if any are present. Supported in the Python and JavaScript SDKs."416 },417 {418 "field": "usage",419 "type": "object",420 "required": false,421 "enum": null,422 "default": null,423 "description": "Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used."424 },425 {426 "field": "usage.input_tokens",427 "type": "integer",428 "required": true,429 "enum": null,430 "default": null,431 "description": "The number of input tokens."432 },433 {434 "field": "usage.input_tokens_details",435 "type": "object",436 "required": true,437 "enum": null,438 "default": null,439 "description": "A detailed breakdown of the input tokens."440 },441 {442 "field": "usage.output_tokens",443 "type": "integer",444 "required": true,445 "enum": null,446 "default": null,447 "description": "The number of output tokens."448 },449 {450 "field": "usage.output_tokens_details",451 "type": "object",452 "required": true,453 "enum": null,454 "default": null,455 "description": "A detailed breakdown of the output tokens."456 },457 {458 "field": "usage.total_tokens",459 "type": "integer",460 "required": true,461 "enum": null,462 "default": null,463 "description": "The total number of tokens used."464 },465 {466 "field": "prompt_cache_options",467 "type": "object",468 "required": false,469 "enum": null,470 "default": null,471 "description": "The prompt-caching options that were applied to the response. Supported for `gpt-5.6` and later models."472 },473 {474 "field": "prompt_cache_options.ttl",475 "type": "string",476 "required": true,477 "enum": [478 "30m"479 ],480 "default": null,481 "description": "The minimum lifetime applied to each cache breakpoint."482 },483 {484 "field": "prompt_cache_options.mode",485 "type": "string",486 "required": true,487 "enum": [488 "implicit",489 "explicit"490 ],491 "default": null,492 "description": "Whether implicit prompt-cache breakpoints were enabled."493 },494 {495 "field": "prompt_cache_options.comparison_response_id",496 "type": "string | null",497 "required": false,498 "enum": null,499 "default": null,500 "description": "The response ID supplied as the prompt cache diagnostics comparison."501 },502 {503 "field": "prompt_cache_diagnostics",504 "type": "object<cache_miss> | object<cache_hit> | object<comparison_response_not_found> | object<unavailable>",505 "required": false,506 "enum": null,507 "default": null,508 "description": "Prompt cache diagnostics requested for this response."509 },510 {511 "field": "prompt_cache_diagnostics(cache_miss)",512 "type": "object",513 "required": false,514 "enum": null,515 "default": null,516 "description": ""517 },518 {519 "field": "prompt_cache_diagnostics(cache_hit)",520 "type": "object",521 "required": false,522 "enum": null,523 "default": null,524 "description": ""525 },526 {527 "field": "prompt_cache_diagnostics(comparison_response_not_found)",528 "type": "object",529 "required": false,530 "enum": null,531 "default": null,532 "description": ""533 },534 {535 "field": "prompt_cache_diagnostics(unavailable)",536 "type": "object",537 "required": false,538 "enum": null,539 "default": null,540 "description": ""541 },542 {543 "field": "moderation",544 "type": "object | null",545 "required": false,546 "enum": null,547 "default": null,548 "description": "Moderation results for the response input and output, if moderated completions were requested."549 },550 {551 "field": "moderation.input",552 "type": "object<moderation_result> | object<error>",553 "required": true,554 "enum": null,555 "default": null,556 "description": "Moderation for the response input."557 },558 {559 "field": "moderation.output",560 "type": "object<moderation_result> | object<error>",561 "required": true,562 "enum": null,563 "default": null,564 "description": "Moderation for the response output."565 },566 {567 "field": "parallel_tool_calls",568 "type": "boolean",569 "required": true,570 "enum": null,571 "default": true,572 "description": "Whether to allow the model to run tool calls in parallel."573 },574 {575 "field": "conversation",576 "type": "object | null",577 "required": false,578 "enum": null,579 "default": null,580 "description": "The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation."581 },582 {583 "field": "conversation.id",584 "type": "string",585 "required": true,586 "enum": null,587 "default": null,588 "description": "The unique ID of the conversation that this response was associated with."589 },590 {591 "field": "max_output_tokens",592 "type": "integer | null",593 "required": false,594 "enum": null,595 "default": null,596 "description": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning)."597 }598 ],599 "status": [600 "DOCUMENTED",601 "LIVE_VERIFIED"602 ],603 "sources": [604 {605 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",606 "retrieved_at": "2026-09-18"607 },608 {609 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",610 "retrieved_at": "2026-09-18"611 }612 ],613 "live_example": {614 "id": "resp_0d1a3b13e2bf34dd006aade8fd690487d2847f660abddbda1b",615 "object": "response",616 "created_at": 1789782269,617 "status": "completed",618 "background": false,619 "billing": {620 "payer": "developer"621 },622 "completed_at": 1789782270,623 "error": null,624 "frequency_penalty": 0.0,625 "incomplete_details": null,626 "instructions": null,627 "max_output_tokens": 32,628 "max_tool_calls": null,629 "model": "gpt-5.4-nano-2026-03-17",630 "moderation": null,631 "output": [632 {633 "id": "msg_0d1a3b13e2bf34dd006aade8fdd89c87d290d9a0f6c0dfc081",634 "type": "message",635 "status": "completed",636 "content": [637 {638 "type": "output_text",639 "annotations": [],640 "logprobs": [],641 "text": "OK."642 }643 ],644 "phase": "final_answer",645 "role": "assistant"646 }647 ],648 "parallel_tool_calls": true,649 "presence_penalty": 0.0,650 "previous_response_id": null,651 "prompt_cache_key": null,652 "prompt_cache_retention": "24h",653 "reasoning": {654 "context": "current_turn",655 "effort": "none",656 "mode": "standard",657 "summary": null658 },659 "safety_identifier": null,660 "service_tier": "default",661 "store": true,662 "temperature": 1.0,663 "text": {664 "format": {665 "type": "text"666 },667 "verbosity": "medium"668 },669 "tool_choice": "auto",670 "tool_usage": {671 "image_gen": {672 "input_tokens": 0,673 "input_tokens_details": {674 "image_tokens": 0,675 "text_tokens": 0676 },677 "output_tokens": 0,678 "output_tokens_details": {679 "image_tokens": 0,680 "text_tokens": 0681 },682 "total_tokens": 0683 },684 "web_search": {685 "num_requests": 0686 }687 },688 "tools": [],689 "top_logprobs": 0,690 "top_p": 0.98,691 "truncation": "disabled",692 "usage": {693 "input_tokens": 10,694 "input_tokens_details": {695 "cache_write_tokens": 0,696 "cached_tokens": 0697 },698 "output_tokens": 6,699 "output_tokens_details": {700 "reasoning_tokens": 0701 },702 "total_tokens": 16703 },704 "user": null,705 "metadata": {}706 },707 "live_fields_not_in_spec": [708 "billing",709 "frequency_penalty",710 "presence_penalty",711 "store",712 "tool_choice",713 "tool_usage",714 "tools"715 ],716 "live_notes": {717 "billing": "{\"payer\": \"developer\"} — undocumented; likely marks who pays (developer vs end-user via sign-in with ChatGPT).",718 "tool_usage": "image_gen token breakdown + web_search.num_requests — undocumented in Response schema.",719 "frequency_penalty/presence_penalty": "echoed as 0.0 although not Responses request parameters.",720 "reasoning": "echoed as {context, effort, mode, summary} even when not requested (effort \"none\" default on gpt-5.4-nano).",721 "top_p": "0.98 default on gpt-5.4-nano.",722 "text.verbosity": "\"medium\" default.",723 "prompt_cache_retention": "\"24h\" default (non-ZDR org)."724 }725 },726 {727 "provider": "openai",728 "object": "Response.usage (ResponseUsage)",729 "type_or_object_value": "usage",730 "description": "Token accounting for a response.",731 "fields": [732 {733 "field": "input_tokens",734 "type": "integer",735 "required": true,736 "enum": null,737 "default": null,738 "description": "The number of input tokens."739 },740 {741 "field": "input_tokens_details",742 "type": "object",743 "required": true,744 "enum": null,745 "default": null,746 "description": "A detailed breakdown of the input tokens."747 },748 {749 "field": "input_tokens_details.cached_tokens",750 "type": "integer",751 "required": true,752 "enum": null,753 "default": null,754 "description": "The number of tokens that were retrieved from the cache. [More on prompt caching](https://developers.openai.com/api/docs/guides/prompt-caching)."755 },756 {757 "field": "input_tokens_details.cache_write_tokens",758 "type": "integer",759 "required": true,760 "enum": null,761 "default": null,762 "description": "The number of input tokens that were written to the cache."763 },764 {765 "field": "output_tokens",766 "type": "integer",767 "required": true,768 "enum": null,769 "default": null,770 "description": "The number of output tokens."771 },772 {773 "field": "output_tokens_details",774 "type": "object",775 "required": true,776 "enum": null,777 "default": null,778 "description": "A detailed breakdown of the output tokens."779 },780 {781 "field": "output_tokens_details.reasoning_tokens",782 "type": "integer",783 "required": true,784 "enum": null,785 "default": null,786 "description": "The number of reasoning tokens."787 },788 {789 "field": "total_tokens",790 "type": "integer",791 "required": true,792 "enum": null,793 "default": null,794 "description": "The total number of tokens used."795 }796 ],797 "status": [798 "DOCUMENTED",799 "LIVE_VERIFIED"800 ],801 "sources": [802 {803 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",804 "retrieved_at": "2026-09-18"805 },806 {807 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",808 "retrieved_at": "2026-09-18"809 }810 ],811 "live_example": {812 "input_tokens": 28,813 "input_tokens_details": {814 "cache_write_tokens": 0,815 "cached_tokens": 0816 },817 "output_tokens": 125,818 "output_tokens_details": {819 "reasoning_tokens": 118820 },821 "total_tokens": 153822 },823 "notes": "reasoning_tokens counted inside output_tokens; cached_tokens/cache_write_tokens inside input_tokens (cache_write_tokens only billed extra on GPT-5.6+)."824 },825 {826 "provider": "openai",827 "object": "Response.incomplete_details",828 "type_or_object_value": "incomplete_details",829 "description": "Why a response ended with status=incomplete.",830 "fields": [831 {832 "field": "reason",833 "type": "string",834 "required": false,835 "enum": [836 "max_output_tokens",837 "max_messages",838 "content_filter",839 "steered"840 ],841 "description": "steered = stopped at a safe boundary after a WebSocket response.steer."842 }843 ],844 "status": [845 "DOCUMENTED",846 "LIVE_VERIFIED"847 ],848 "sources": [849 {850 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",851 "retrieved_at": "2026-09-18"852 },853 {854 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",855 "retrieved_at": "2026-09-18"856 }857 ],858 "live_example": {859 "reason": "max_output_tokens"860 },861 "notes": "Live f2: reasoning consumed all 32 output tokens -> status incomplete, output=[reasoning item only]."862 },863 {864 "provider": "openai",865 "object": "Response.error (ResponseError)",866 "type_or_object_value": "error",867 "description": "Error object set when status=failed.",868 "fields": [869 {870 "field": "code",871 "type": "string",872 "required": true,873 "enum": [874 "server_error",875 "rate_limit_exceeded",876 "invalid_prompt",877 "data_residency_mismatch",878 "bio_policy",879 "misalignment_policy_violation",880 "vector_store_timeout",881 "invalid_image",882 "invalid_image_format",883 "invalid_base64_image",884 "invalid_image_url",885 "image_too_large",886 "image_too_small",887 "image_parse_error",888 "image_content_policy_violation",889 "invalid_image_mode",890 "image_file_too_large",891 "unsupported_image_media_type",892 "empty_image_file",893 "failed_to_download_image",894 "image_file_not_found"895 ],896 "default": null,897 "description": "The error code for the response."898 },899 {900 "field": "message",901 "type": "string",902 "required": true,903 "enum": null,904 "default": null,905 "description": "A human-readable description of the error."906 },907 {908 "field": "misalignment",909 "type": "object",910 "required": false,911 "enum": null,912 "default": null,913 "description": ""914 },915 {916 "field": "misalignment.error_type",917 "type": "string",918 "required": false,919 "enum": null,920 "default": null,921 "description": "An optional classification; clients must accept additional values."922 },923 {924 "field": "misalignment.detailed_explanation",925 "type": "string",926 "required": false,927 "enum": null,928 "default": null,929 "description": "The public explanation for this block."930 },931 {932 "field": "misalignment.steer",933 "type": "object",934 "required": false,935 "enum": null,936 "default": null,937 "description": "An optional public continuation instruction."938 },939 {940 "field": "misalignment.steer.message",941 "type": "string",942 "required": true,943 "enum": null,944 "default": null,945 "description": "The public continuation instruction."946 }947 ],948 "status": [949 "DOCUMENTED"950 ],951 "sources": [952 {953 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",954 "retrieved_at": "2026-09-18"955 },956 {957 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",958 "retrieved_at": "2026-09-18"959 }960 ]961 },962 {963 "provider": "openai",964 "object": "Response.reasoning (Reasoning, echoed)",965 "type_or_object_value": "reasoning",966 "description": "Effective reasoning configuration echoed on the response (mode, effort, summary, context).",967 "fields": [968 {969 "field": "mode",970 "type": "string | null",971 "required": false,972 "enum": [973 "standard",974 "pro"975 ],976 "description": "Effective execution mode"977 },978 {979 "field": "effort",980 "type": "string | null",981 "required": false,982 "enum": [983 "none",984 "minimal",985 "low",986 "medium",987 "high",988 "xhigh",989 "max"990 ],991 "description": "Effective effort"992 },993 {994 "field": "summary",995 "type": "string | null",996 "required": false,997 "enum": [998 "auto",999 "concise",1000 "detailed"1001 ],1002 "description": "Requested summary mode; \"auto\" echoed as \"detailed\" live"1003 },1004 {1005 "field": "context",1006 "type": "string | null",1007 "required": false,1008 "enum": [1009 "auto",1010 "current_turn",1011 "all_turns"1012 ],1013 "description": "Effective reasoning context mode"1014 }1015 ],1016 "status": [1017 "DOCUMENTED",1018 "LIVE_VERIFIED"1019 ],1020 "sources": [1021 {1022 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",1023 "retrieved_at": "2026-09-18"1024 },1025 {1026 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",1027 "retrieved_at": "2026-09-18"1028 }1029 ],1030 "live_example": {1031 "context": "current_turn",1032 "effort": "medium",1033 "mode": "standard",1034 "summary": "detailed"1035 }1036 },1037 {1038 "provider": "openai",1039 "object": "Response.conversation (ResponseConversation)",1040 "type_or_object_value": "conversation",1041 "description": "Conversation the response belongs to.",1042 "fields": [1043 {1044 "field": "id",1045 "type": "string",1046 "required": true,1047 "enum": null,1048 "default": null,1049 "description": "The unique ID of the conversation that this response was associated with."1050 }1051 ],1052 "status": [1053 "DOCUMENTED",1054 "LIVE_VERIFIED"1055 ],1056 "sources": [1057 {1058 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",1059 "retrieved_at": "2026-09-18"1060 },1061 {1062 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",1063 "retrieved_at": "2026-09-18"1064 }1065 ],1066 "live_example": {1067 "id": "conv_..."1068 }1069 },1070 {1071 "provider": "openai",1072 "object": "Response.prompt_cache_options / prompt_cache_diagnostics",1073 "type_or_object_value": "prompt_cache_options",1074 "description": "Echo of caching options and (GPT-5.6+) diagnostics: type cache_hit | cache_miss{reason, comparison_reusable_tokens, cache_missed_tokens} | comparison_response_not_found | unavailable.",1075 "fields": [1076 {1077 "field": "ttl",1078 "type": "string",1079 "required": true,1080 "enum": [1081 "30m"1082 ],1083 "default": null,1084 "description": "The minimum lifetime applied to each cache breakpoint."1085 },1086 {1087 "field": "mode",1088 "type": "string",1089 "required": true,1090 "enum": [1091 "implicit",1092 "explicit"1093 ],1094 "default": null,1095 "description": "Whether implicit prompt-cache breakpoints were enabled."1096 },1097 {1098 "field": "comparison_response_id",1099 "type": "string | null",1100 "required": false,1101 "enum": null,1102 "default": null,1103 "description": "The response ID supplied as the prompt cache diagnostics comparison."1104 },1105 {1106 "field": "(cache_miss)",1107 "type": "object",1108 "required": false,1109 "enum": null,1110 "default": null,1111 "description": ""1112 },1113 {1114 "field": "(cache_hit)",1115 "type": "object",1116 "required": false,1117 "enum": null,1118 "default": null,1119 "description": ""1120 },1121 {1122 "field": "(comparison_response_not_found)",1123 "type": "object",1124 "required": false,1125 "enum": null,1126 "default": null,1127 "description": ""1128 },1129 {1130 "field": "(unavailable)",1131 "type": "object",1132 "required": false,1133 "enum": null,1134 "default": null,1135 "description": ""1136 }1137 ],1138 "status": [1139 "DOCUMENTED",1140 "UNVERIFIED"1141 ],1142 "sources": [1143 {1144 "url": "https://developers.openai.com/api/docs/guides/prompt-caching/diagnostics",1145 "retrieved_at": "2026-09-18"1146 },1147 {1148 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",1149 "retrieved_at": "2026-09-18"1150 }1151 ]1152 },1153 {1154 "provider": "openai",1155 "object": "Response.moderation (Moderation)",1156 "type_or_object_value": "moderation",1157 "description": "Moderation results when `moderation` was requested on create.",1158 "fields": [1159 {1160 "field": "input",1161 "type": "object<moderation_result> | object<error>",1162 "required": true,1163 "enum": null,1164 "default": null,1165 "description": "Moderation for the response input."1166 },1167 {1168 "field": "input(moderation_result)",1169 "type": "object",1170 "required": true,1171 "enum": null,1172 "default": null,1173 "description": "A moderation result produced for the response input or output."1174 },1175 {1176 "field": "input(moderation_result).type",1177 "type": "string",1178 "required": true,1179 "enum": [1180 "moderation_result"1181 ],1182 "default": "moderation_result",1183 "description": "The object type, which was always `moderation_result` for successful moderation results."1184 },1185 {1186 "field": "input(moderation_result).model",1187 "type": "string",1188 "required": true,1189 "enum": null,1190 "default": null,1191 "description": "The moderation model that produced this result."1192 },1193 {1194 "field": "input(moderation_result).flagged",1195 "type": "boolean",1196 "required": true,1197 "enum": null,1198 "default": null,1199 "description": "A boolean indicating whether the content was flagged by any category."1200 },1201 {1202 "field": "input(moderation_result).categories",1203 "type": "map<string,boolean>",1204 "required": true,1205 "enum": null,1206 "default": null,1207 "description": "A dictionary of moderation categories to booleans, True if the input is flagged under this category."1208 },1209 {1210 "field": "input(moderation_result).category_scores",1211 "type": "map<string,number>",1212 "required": true,1213 "enum": null,1214 "default": null,1215 "description": "A dictionary of moderation categories to scores."1216 },1217 {1218 "field": "input(moderation_result).category_applied_input_types",1219 "type": "map<string,array<string>>",1220 "required": true,1221 "enum": null,1222 "default": null,1223 "description": "Which modalities of input are reflected by the score for each category."1224 },1225 {1226 "field": "input(error)",1227 "type": "object",1228 "required": true,1229 "enum": null,1230 "default": null,1231 "description": "An error produced while attempting moderation for the response input or output."1232 },1233 {1234 "field": "input(error).type",1235 "type": "string",1236 "required": true,1237 "enum": [1238 "error"1239 ],1240 "default": "error",1241 "description": "The object type, which was always `error` for moderation failures."1242 },1243 {1244 "field": "input(error).code",1245 "type": "string",1246 "required": true,1247 "enum": null,1248 "default": null,1249 "description": "The error code."1250 },1251 {1252 "field": "input(error).message",1253 "type": "string",1254 "required": true,1255 "enum": null,1256 "default": null,1257 "description": "The error message."1258 },1259 {1260 "field": "output",1261 "type": "object<moderation_result> | object<error>",1262 "required": true,1263 "enum": null,1264 "default": null,1265 "description": "Moderation for the response output."1266 },1267 {1268 "field": "output(moderation_result)",1269 "type": "object",1270 "required": true,1271 "enum": null,1272 "default": null,1273 "description": "A moderation result produced for the response input or output."1274 },1275 {1276 "field": "output(moderation_result).type",1277 "type": "string",1278 "required": true,1279 "enum": [1280 "moderation_result"1281 ],1282 "default": "moderation_result",1283 "description": "The object type, which was always `moderation_result` for successful moderation results."1284 },1285 {1286 "field": "output(moderation_result).model",1287 "type": "string",1288 "required": true,1289 "enum": null,1290 "default": null,1291 "description": "The moderation model that produced this result."1292 },1293 {1294 "field": "output(moderation_result).flagged",1295 "type": "boolean",1296 "required": true,1297 "enum": null,1298 "default": null,1299 "description": "A boolean indicating whether the content was flagged by any category."1300 },1301 {1302 "field": "output(moderation_result).categories",1303 "type": "map<string,boolean>",1304 "required": true,1305 "enum": null,1306 "default": null,1307 "description": "A dictionary of moderation categories to booleans, True if the input is flagged under this category."1308 },1309 {1310 "field": "output(moderation_result).category_scores",1311 "type": "map<string,number>",1312 "required": true,1313 "enum": null,1314 "default": null,1315 "description": "A dictionary of moderation categories to scores."1316 },1317 {1318 "field": "output(moderation_result).category_applied_input_types",1319 "type": "map<string,array<string>>",1320 "required": true,1321 "enum": null,1322 "default": null,1323 "description": "Which modalities of input are reflected by the score for each category."1324 },1325 {1326 "field": "output(error)",1327 "type": "object",1328 "required": true,1329 "enum": null,1330 "default": null,1331 "description": "An error produced while attempting moderation for the response input or output."1332 },1333 {1334 "field": "output(error).type",1335 "type": "string",1336 "required": true,1337 "enum": [1338 "error"1339 ],1340 "default": "error",1341 "description": "The object type, which was always `error` for moderation failures."1342 },1343 {1344 "field": "output(error).code",1345 "type": "string",1346 "required": true,1347 "enum": null,1348 "default": null,1349 "description": "The error code."1350 },1351 {1352 "field": "output(error).message",1353 "type": "string",1354 "required": true,1355 "enum": null,1356 "default": null,1357 "description": "The error message."1358 }1359 ],1360 "status": [1361 "DOCUMENTED",1362 "UNVERIFIED"1363 ],1364 "sources": [1365 {1366 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",1367 "retrieved_at": "2026-09-18"1368 },1369 {1370 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",1371 "retrieved_at": "2026-09-18"1372 }1373 ]1374 },1375 {1376 "provider": "openai",1377 "object": "Output item: message (OutputMessage)",1378 "type_or_object_value": "type = \"message\"",1379 "description": "Assistant message output item. content[] is output_text | refusal. Live adds `phase` (commentary | final_answer).",1380 "fields": [1381 {1382 "field": "id",1383 "type": "string",1384 "required": true,1385 "enum": null,1386 "default": null,1387 "description": "The unique ID of the output message."1388 },1389 {1390 "field": "type",1391 "type": "string",1392 "required": true,1393 "enum": [1394 "message"1395 ],1396 "default": null,1397 "description": "The type of the output message. Always `message`."1398 },1399 {1400 "field": "role",1401 "type": "string",1402 "required": true,1403 "enum": [1404 "assistant"1405 ],1406 "default": null,1407 "description": "The role of the output message. Always `assistant`."1408 },1409 {1410 "field": "content",1411 "type": "array<object<output_text> | object<refusal>>",1412 "required": true,1413 "enum": null,1414 "default": null,1415 "description": "The content of the output message."1416 },1417 {1418 "field": "content[]",1419 "type": "object<output_text> | object<refusal>",1420 "required": false,1421 "enum": null,1422 "default": null,1423 "description": ""1424 },1425 {1426 "field": "content[](output_text)",1427 "type": "object",1428 "required": false,1429 "enum": null,1430 "default": null,1431 "description": "A text output from the model."1432 },1433 {1434 "field": "content[](output_text).type",1435 "type": "string",1436 "required": true,1437 "enum": [1438 "output_text"1439 ],1440 "default": "output_text",1441 "description": "The type of the output text. Always `output_text`."1442 },1443 {1444 "field": "content[](output_text).text",1445 "type": "string",1446 "required": true,1447 "enum": null,1448 "default": null,1449 "description": "The text output from the model."1450 },1451 {1452 "field": "content[](output_text).annotations",1453 "type": "array<object<file_citation> | object<url_citation> | object<container_file_citation> | object<file_path>>",1454 "required": true,1455 "enum": null,1456 "default": null,1457 "description": "The annotations of the text output."1458 },1459 {1460 "field": "content[](output_text).logprobs",1461 "type": "array<object>",1462 "required": true,1463 "enum": null,1464 "default": null,1465 "description": ""1466 },1467 {1468 "field": "content[](refusal)",1469 "type": "object",1470 "required": false,1471 "enum": null,1472 "default": null,1473 "description": "A refusal from the model."1474 },1475 {1476 "field": "content[](refusal).type",1477 "type": "string",1478 "required": true,1479 "enum": [1480 "refusal"1481 ],1482 "default": "refusal",1483 "description": "The type of the refusal. Always `refusal`."1484 },1485 {1486 "field": "content[](refusal).refusal",1487 "type": "string",1488 "required": true,1489 "enum": null,1490 "default": null,1491 "description": "The refusal explanation from the model."1492 },1493 {1494 "field": "phase",1495 "type": "string | null",1496 "required": false,1497 "enum": [1498 "commentary",1499 "final_answer"1500 ],1501 "default": null,1502 "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages."1503 },1504 {1505 "field": "status",1506 "type": "string",1507 "required": true,1508 "enum": [1509 "in_progress",1510 "completed",1511 "incomplete"1512 ],1513 "default": null,1514 "description": "The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API."1515 }1516 ],1517 "status": [1518 "DOCUMENTED",1519 "LIVE_VERIFIED"1520 ],1521 "sources": [1522 {1523 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",1524 "retrieved_at": "2026-09-18"1525 },1526 {1527 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",1528 "retrieved_at": "2026-09-18"1529 }1530 ],1531 "live_example": {1532 "id": "msg_0d1a3b13e2bf34dd006aade8fdd89c87d290d9a0f6c0dfc081",1533 "type": "message",1534 "status": "completed",1535 "content": [1536 {1537 "type": "output_text",1538 "annotations": [],1539 "logprobs": [],1540 "text": "OK."1541 }1542 ],1543 "phase": "final_answer",1544 "role": "assistant"1545 }1546 },1547 {1548 "provider": "openai",1549 "object": "Output content: output_text",1550 "type_or_object_value": "type = \"output_text\"",1551 "description": "Text content part with annotations[] and logprobs[].",1552 "fields": [1553 {1554 "field": "type",1555 "type": "string",1556 "required": true,1557 "enum": [1558 "output_text"1559 ],1560 "default": "output_text",1561 "description": "The type of the output text. Always `output_text`."1562 },1563 {1564 "field": "text",1565 "type": "string",1566 "required": true,1567 "enum": null,1568 "default": null,1569 "description": "The text output from the model."1570 },1571 {1572 "field": "annotations",1573 "type": "array<object<file_citation> | object<url_citation> | object<container_file_citation> | object<file_path>>",1574 "required": true,1575 "enum": null,1576 "default": null,1577 "description": "The annotations of the text output."1578 },1579 {1580 "field": "annotations[]",1581 "type": "object<file_citation> | object<url_citation> | object<container_file_citation> | object<file_path>",1582 "required": false,1583 "enum": null,1584 "default": null,1585 "description": "An annotation that applies to a span of output text."1586 },1587 {1588 "field": "annotations[](file_citation)",1589 "type": "object",1590 "required": false,1591 "enum": null,1592 "default": null,1593 "description": "A citation to a file."1594 },1595 {1596 "field": "annotations[](url_citation)",1597 "type": "object",1598 "required": false,1599 "enum": null,1600 "default": null,1601 "description": "A citation for a web resource used to generate a model response."1602 },1603 {1604 "field": "annotations[](container_file_citation)",1605 "type": "object",1606 "required": false,1607 "enum": null,1608 "default": null,1609 "description": "A citation for a container file used to generate a model response."1610 },1611 {1612 "field": "annotations[](file_path)",1613 "type": "object",1614 "required": false,1615 "enum": null,1616 "default": null,1617 "description": "A path to a file."1618 },1619 {1620 "field": "logprobs",1621 "type": "array<object>",1622 "required": true,1623 "enum": null,1624 "default": null,1625 "description": ""1626 },1627 {1628 "field": "logprobs[]",1629 "type": "object",1630 "required": false,1631 "enum": null,1632 "default": null,1633 "description": "The log probability of a token."1634 },1635 {1636 "field": "logprobs[].token",1637 "type": "string",1638 "required": true,1639 "enum": null,1640 "default": null,1641 "description": ""1642 },1643 {1644 "field": "logprobs[].logprob",1645 "type": "number",1646 "required": true,1647 "enum": null,1648 "default": null,1649 "description": ""1650 },1651 {1652 "field": "logprobs[].bytes",1653 "type": "array<integer>",1654 "required": true,1655 "enum": null,1656 "default": null,1657 "description": ""1658 },1659 {1660 "field": "logprobs[].top_logprobs",1661 "type": "array<object>",1662 "required": true,1663 "enum": null,1664 "default": null,1665 "description": ""1666 },1667 {1668 "field": "annotations[] (Annotation)",1669 "type": "file_citation | url_citation | container_file_citation | file_path",1670 "required": true,1671 "description": "See Annotation schema (tools agents document citation shapes)."1672 }1673 ],1674 "status": [1675 "DOCUMENTED",1676 "LIVE_VERIFIED"1677 ],1678 "sources": [1679 {1680 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",1681 "retrieved_at": "2026-09-18"1682 },1683 {1684 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",1685 "retrieved_at": "2026-09-18"1686 }1687 ],1688 "live_example": {1689 "type": "output_text",1690 "annotations": [],1691 "logprobs": [],1692 "text": "OK."1693 }1694 },1695 {1696 "provider": "openai",1697 "object": "Output content: refusal",1698 "type_or_object_value": "type = \"refusal\"",1699 "description": "Refusal content part.",1700 "fields": [1701 {1702 "field": "type",1703 "type": "string",1704 "required": true,1705 "enum": [1706 "refusal"1707 ],1708 "default": "refusal",1709 "description": "The type of the refusal. Always `refusal`."1710 },1711 {1712 "field": "refusal",1713 "type": "string",1714 "required": true,1715 "enum": null,1716 "default": null,1717 "description": "The refusal explanation from the model."1718 }1719 ],1720 "status": [1721 "DOCUMENTED"1722 ],1723 "sources": [1724 {1725 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",1726 "retrieved_at": "2026-09-18"1727 },1728 {1729 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",1730 "retrieved_at": "2026-09-18"1731 }1732 ]1733 },1734 {1735 "provider": "openai",1736 "object": "Output item: reasoning (ReasoningItem)",1737 "type_or_object_value": "type = \"reasoning\"",1738 "description": "Reasoning item: summary[] (summary_text), content[] (reasoning_text, rarely populated), encrypted_content (populated by default in stateless mode), status.",1739 "fields": [1740 {1741 "field": "type",1742 "type": "string",1743 "required": true,1744 "enum": [1745 "reasoning"1746 ],1747 "default": null,1748 "description": "The type of the object. Always `reasoning`."1749 },1750 {1751 "field": "id",1752 "type": "string",1753 "required": true,1754 "enum": null,1755 "default": null,1756 "description": "The unique identifier of the reasoning content."1757 },1758 {1759 "field": "encrypted_content",1760 "type": "string | null",1761 "required": false,1762 "enum": null,1763 "default": null,1764 "description": "The encrypted content of the reasoning item. This is populated by default for reasoning items returned by `POST /v1/responses` and WebSocket `response.create` requests. When streaming, use the completed reasoning item and its `encrypted_content` from the `response.output_item.done` event in subsequent requests. The `encrypted_content` in `response.output_item.added` may be incomplete. This is espe"1765 },1766 {1767 "field": "summary",1768 "type": "array<object>",1769 "required": true,1770 "enum": null,1771 "default": null,1772 "description": "Reasoning summary content."1773 },1774 {1775 "field": "summary[]",1776 "type": "object",1777 "required": false,1778 "enum": null,1779 "default": null,1780 "description": "A summary text from the model."1781 },1782 {1783 "field": "summary[].type",1784 "type": "string",1785 "required": true,1786 "enum": [1787 "summary_text"1788 ],1789 "default": "summary_text",1790 "description": "The type of the object. Always `summary_text`."1791 },1792 {1793 "field": "summary[].text",1794 "type": "string",1795 "required": true,1796 "enum": null,1797 "default": null,1798 "description": "A summary of the reasoning output from the model so far."1799 },1800 {1801 "field": "content",1802 "type": "array<object>",1803 "required": false,1804 "enum": null,1805 "default": null,1806 "description": "Reasoning text content."1807 },1808 {1809 "field": "content[]",1810 "type": "object",1811 "required": false,1812 "enum": null,1813 "default": null,1814 "description": "Reasoning text from the model."1815 },1816 {1817 "field": "content[].type",1818 "type": "string",1819 "required": true,1820 "enum": [1821 "reasoning_text"1822 ],1823 "default": "reasoning_text",1824 "description": "The type of the reasoning text. Always `reasoning_text`."1825 },1826 {1827 "field": "content[].text",1828 "type": "string",1829 "required": true,1830 "enum": null,1831 "default": null,1832 "description": "The reasoning text from the model."1833 },1834 {1835 "field": "status",1836 "type": "string",1837 "required": false,1838 "enum": [1839 "in_progress",1840 "completed",1841 "incomplete"1842 ],1843 "default": null,1844 "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."1845 },1846 {1847 "field": "type",1848 "type": "string",1849 "required": true,1850 "enum": [1851 "summary_text"1852 ],1853 "default": "summary_text",1854 "description": "The type of the object. Always `summary_text`."1855 },1856 {1857 "field": "text",1858 "type": "string",1859 "required": true,1860 "enum": null,1861 "default": null,1862 "description": "A summary of the reasoning output from the model so far."1863 }1864 ],1865 "status": [1866 "DOCUMENTED",1867 "LIVE_VERIFIED"1868 ],1869 "sources": [1870 {1871 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",1872 "retrieved_at": "2026-09-18"1873 },1874 {1875 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",1876 "retrieved_at": "2026-09-18"1877 }1878 ],1879 "live_example": {1880 "id": "rs_09d16d4375ddfc5d016aade9a2978c87d29fe2d737d2975c93",1881 "type": "reasoning",1882 "content": [],1883 "encrypted_content": "gAAAAABqremkK8TpNynRJayx...(truncated)",1884 "summary": [1885 {1886 "type": "summary_text",1887 "text": "**Counting letters in 'strawberry'**\n\nI need to count the letter 'r' in \"strawberry\". So, breaking it down: s, t, r, a, w, b, e, r, r, y. The 'r' appears at the 3rd position and also twice at the end. Let’s double-check: I count them as s(1), t(2), r(3), a(4), w(5), b(6), e(7), r(8), r(9), y(10). So, the total for 'r' is indeed 3. The user wants the final answer to be just the number: \"3\"."1888 }1889 ]1890 },1891 "notes": "Live f3 (effort medium, summary auto): 118 reasoning tokens, one summary_text; encrypted_content present with store=false."1892 },1893 {1894 "provider": "openai",1895 "object": "Output/Input item: function_call (FunctionToolCall)",1896 "type_or_object_value": "type = \"function_call\"",1897 "description": "Model-generated function call (id, call_id, name, arguments JSON string, status, caller/namespace/async for programmatic calling).",1898 "fields": [1899 {1900 "field": "id",1901 "type": "string",1902 "required": false,1903 "enum": null,1904 "default": null,1905 "description": "The unique ID of the function tool call."1906 },1907 {1908 "field": "type",1909 "type": "string",1910 "required": true,1911 "enum": [1912 "function_call"1913 ],1914 "default": null,1915 "description": "The type of the function tool call. Always `function_call`."1916 },1917 {1918 "field": "call_id",1919 "type": "string",1920 "required": true,1921 "enum": null,1922 "default": null,1923 "description": "The unique ID of the function tool call generated by the model."1924 },1925 {1926 "field": "caller",1927 "type": "object<direct> | object<program>",1928 "required": false,1929 "enum": null,1930 "default": null,1931 "description": "The execution context that produced this tool call."1932 },1933 {1934 "field": "caller(direct)",1935 "type": "object",1936 "required": false,1937 "enum": null,1938 "default": null,1939 "description": ""1940 },1941 {1942 "field": "caller(program)",1943 "type": "object",1944 "required": false,1945 "enum": null,1946 "default": null,1947 "description": ""1948 },1949 {1950 "field": "namespace",1951 "type": "string",1952 "required": false,1953 "enum": null,1954 "default": null,1955 "description": "The namespace of the function to run."1956 },1957 {1958 "field": "name",1959 "type": "string",1960 "required": true,1961 "enum": null,1962 "default": null,1963 "description": "The name of the function to run."1964 },1965 {1966 "field": "arguments",1967 "type": "string",1968 "required": true,1969 "enum": null,1970 "default": null,1971 "description": "A JSON string of the arguments to pass to the function."1972 },1973 {1974 "field": "status",1975 "type": "string",1976 "required": false,1977 "enum": [1978 "in_progress",1979 "completed",1980 "incomplete"1981 ],1982 "default": null,1983 "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."1984 },1985 {1986 "field": "async",1987 "type": "boolean",1988 "required": false,1989 "enum": null,1990 "default": null,1991 "description": "Whether the function tool call runs asynchronously."1992 }1993 ],1994 "status": [1995 "DOCUMENTED"1996 ],1997 "sources": [1998 {1999 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",2000 "retrieved_at": "2026-09-18"2001 },2002 {2003 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2004 "retrieved_at": "2026-09-18"2005 }2006 ]2007 },2008 {2009 "provider": "openai",2010 "object": "Input item: function_call_output",2011 "type_or_object_value": "type = \"function_call_output\"",2012 "description": "Your function result: call_id + output (string or input_text/input_image/input_file parts).",2013 "fields": [2014 {2015 "field": "id",2016 "type": "string | null",2017 "required": false,2018 "enum": null,2019 "default": null,2020 "description": "The unique ID of the function tool call output. Populated when this item is returned via API."2021 },2022 {2023 "field": "call_id",2024 "type": "string | null",2025 "required": false,2026 "enum": null,2027 "default": null,2028 "description": "The unique ID of the function tool call generated by the model."2029 },2030 {2031 "field": "type",2032 "type": "string",2033 "required": true,2034 "enum": [2035 "function_call_output"2036 ],2037 "default": "function_call_output",2038 "description": "The type of the function tool call output. Always `function_call_output`."2039 },2040 {2041 "field": "output",2042 "type": "string | array<object<input_text> | object<input_image> | object<input_file>>",2043 "required": true,2044 "enum": null,2045 "default": null,2046 "description": "Text, image, or file output of the function tool call."2047 },2048 {2049 "field": "output[]",2050 "type": "array<object<input_text> | object<input_image> | object<input_file>> | object<input_text> | object<input_file>",2051 "required": false,2052 "enum": null,2053 "default": null,2054 "description": "An array of content outputs (text, image, file) for the function tool call."2055 },2056 {2057 "field": "output[](input_text)",2058 "type": "object",2059 "required": false,2060 "enum": null,2061 "default": null,2062 "description": "A text input to the model."2063 },2064 {2065 "field": "output[](input_image)",2066 "type": "object",2067 "required": false,2068 "enum": null,2069 "default": null,2070 "description": "An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)"2071 },2072 {2073 "field": "output[](input_file)",2074 "type": "object",2075 "required": false,2076 "enum": null,2077 "default": null,2078 "description": "A file input to the model."2079 },2080 {2081 "field": "name",2082 "type": "string | null",2083 "required": false,2084 "enum": null,2085 "default": null,2086 "description": "The name of the tool that produced the output."2087 },2088 {2089 "field": "namespace",2090 "type": "string | null",2091 "required": false,2092 "enum": null,2093 "default": null,2094 "description": "The namespace of the tool that produced the output."2095 },2096 {2097 "field": "caller",2098 "type": "object<direct> | object<program>",2099 "required": false,2100 "enum": null,2101 "default": null,2102 "description": "The execution context that produced this tool call."2103 },2104 {2105 "field": "caller(direct)",2106 "type": "object",2107 "required": false,2108 "enum": null,2109 "default": null,2110 "description": ""2111 },2112 {2113 "field": "caller(direct).type",2114 "type": "string",2115 "required": true,2116 "enum": [2117 "direct"2118 ],2119 "default": "direct",2120 "description": "The caller type. Always `direct`."2121 },2122 {2123 "field": "caller(program)",2124 "type": "object",2125 "required": false,2126 "enum": null,2127 "default": null,2128 "description": ""2129 },2130 {2131 "field": "caller(program).type",2132 "type": "string",2133 "required": true,2134 "enum": [2135 "program"2136 ],2137 "default": "program",2138 "description": "The caller type. Always `program`."2139 },2140 {2141 "field": "caller(program).caller_id",2142 "type": "string",2143 "required": true,2144 "enum": null,2145 "default": null,2146 "description": "The call ID of the program item that produced this tool call."2147 },2148 {2149 "field": "status",2150 "type": "string | null",2151 "required": false,2152 "enum": [2153 "in_progress",2154 "completed",2155 "incomplete"2156 ],2157 "default": null,2158 "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."2159 }2160 ],2161 "status": [2162 "DOCUMENTED"2163 ],2164 "sources": [2165 {2166 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",2167 "retrieved_at": "2026-09-18"2168 },2169 {2170 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2171 "retrieved_at": "2026-09-18"2172 }2173 ]2174 },2175 {2176 "provider": "openai",2177 "object": "Item: compaction (CompactionSummaryItemParam)",2178 "type_or_object_value": "type = \"compaction\"",2179 "description": "Opaque compacted context (encrypted_content) produced by /responses/compact or server-side compaction; replay as an input item.",2180 "fields": [2181 {2182 "field": "id",2183 "type": "string | null",2184 "required": false,2185 "enum": null,2186 "default": null,2187 "description": "The ID of the compaction item."2188 },2189 {2190 "field": "type",2191 "type": "string",2192 "required": true,2193 "enum": [2194 "compaction"2195 ],2196 "default": "compaction",2197 "description": "The type of the item. Always `compaction`."2198 },2199 {2200 "field": "encrypted_content",2201 "type": "string",2202 "required": true,2203 "enum": null,2204 "default": null,2205 "description": "The encrypted content of the compaction summary."2206 }2207 ],2208 "status": [2209 "DOCUMENTED",2210 "LIVE_VERIFIED"2211 ],2212 "sources": [2213 {2214 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",2215 "retrieved_at": "2026-09-18"2216 },2217 {2218 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2219 "retrieved_at": "2026-09-18"2220 }2221 ],2222 "live_example": {2223 "id": "cmp_0ed5b67e8da655fb016aade904992087d2a7f4f8dbfac97dfa",2224 "type": "compaction",2225 "encrypted_content": "gAAAAABqrekFMDjkZ64ju-Up...(truncated)"2226 }2227 },2228 {2229 "provider": "openai",2230 "object": "Input item: compaction_trigger",2231 "type_or_object_value": "type = \"compaction_trigger\"",2232 "description": "Requests compaction of the current context; must be the final input item.",2233 "fields": [2234 {2235 "field": "type",2236 "type": "string",2237 "required": true,2238 "enum": [2239 "compaction_trigger"2240 ],2241 "description": ""2242 },2243 {2244 "field": "id",2245 "type": "string | null",2246 "required": false,2247 "description": ""2248 }2249 ],2250 "status": [2251 "DOCUMENTED",2252 "UNVERIFIED"2253 ],2254 "sources": [2255 {2256 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",2257 "retrieved_at": "2026-09-18"2258 },2259 {2260 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2261 "retrieved_at": "2026-09-18"2262 }2263 ]2264 },2265 {2266 "provider": "openai",2267 "object": "Input item: configuration_update",2268 "type_or_object_value": "type = \"configuration_update\"",2269 "description": "Changes reasoning effort mid-conversation without rewriting the cached prefix (gpt-6-astra only).",2270 "fields": [2271 {2272 "field": "type",2273 "type": "string",2274 "required": true,2275 "enum": [2276 "configuration_update"2277 ],2278 "description": ""2279 },2280 {2281 "field": "reasoning.effort",2282 "type": "string",2283 "required": false,2284 "enum": [2285 "none",2286 "minimal",2287 "low",2288 "medium",2289 "high",2290 "xhigh",2291 "max"2292 ],2293 "description": ""2294 }2295 ],2296 "status": [2297 "DOCUMENTED",2298 "UNVERIFIED"2299 ],2300 "sources": [2301 {2302 "url": "https://developers.openai.com/api/docs/guides/reasoning#change-reasoning-mid-conversation",2303 "retrieved_at": "2026-09-18"2304 },2305 {2306 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2307 "retrieved_at": "2026-09-18"2308 }2309 ]2310 },2311 {2312 "provider": "openai",2313 "object": "Input item: item_reference",2314 "type_or_object_value": "type = \"item_reference\"",2315 "description": "Reference to an existing stored item by id.",2316 "fields": [2317 {2318 "field": "type",2319 "type": "string | null",2320 "required": false,2321 "enum": [2322 "item_reference"2323 ],2324 "default": "item_reference",2325 "description": "The type of item to reference. Always `item_reference`."2326 },2327 {2328 "field": "id",2329 "type": "string",2330 "required": true,2331 "enum": null,2332 "default": null,2333 "description": "The ID of the item to reference."2334 }2335 ],2336 "status": [2337 "DOCUMENTED",2338 "UNVERIFIED"2339 ],2340 "sources": [2341 {2342 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",2343 "retrieved_at": "2026-09-18"2344 },2345 {2346 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2347 "retrieved_at": "2026-09-18"2348 }2349 ]2350 },2351 {2352 "provider": "openai",2353 "object": "Input item: message (EasyInputMessage / InputMessage)",2354 "type_or_object_value": "type = \"message\" (type optional)",2355 "description": "Input message: role user|assistant|system|developer, content string or parts (input_text | input_image | input_file | input_audio), optional phase for assistant.",2356 "fields": [2357 {2358 "field": "role",2359 "type": "string",2360 "required": true,2361 "enum": [2362 "user",2363 "assistant",2364 "system",2365 "developer"2366 ],2367 "default": null,2368 "description": "The role of the message input. One of `user`, `assistant`, `system`, or `developer`."2369 },2370 {2371 "field": "content",2372 "type": "string | array<object<input_text> | object<input_image> | object<input_file>>",2373 "required": true,2374 "enum": null,2375 "default": null,2376 "description": "Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses."2377 },2378 {2379 "field": "content[]",2380 "type": "array<object<input_text> | object<input_image> | object<input_file>> | object<input_text> | object<input_file>",2381 "required": false,2382 "enum": null,2383 "default": null,2384 "description": "A list of one or many input items to the model, containing different content types."2385 },2386 {2387 "field": "phase",2388 "type": "string | null",2389 "required": false,2390 "enum": [2391 "commentary",2392 "final_answer"2393 ],2394 "default": null,2395 "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages."2396 },2397 {2398 "field": "type",2399 "type": "string",2400 "required": false,2401 "enum": [2402 "message"2403 ],2404 "default": null,2405 "description": "The type of the message input. Always `message`."2406 },2407 {2408 "field": "status",2409 "type": "string",2410 "required": false,2411 "enum": [2412 "in_progress",2413 "completed",2414 "incomplete"2415 ],2416 "default": null,2417 "description": "The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."2418 },2419 {2420 "field": "content[]",2421 "type": "object<input_text> | object<input_image> | object<input_file>",2422 "required": false,2423 "enum": null,2424 "default": null,2425 "description": ""2426 },2427 {2428 "field": "content[](input_text)",2429 "type": "object",2430 "required": false,2431 "enum": null,2432 "default": null,2433 "description": "A text input to the model."2434 },2435 {2436 "field": "content[](input_image)",2437 "type": "object",2438 "required": false,2439 "enum": null,2440 "default": null,2441 "description": "An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)."2442 },2443 {2444 "field": "content[](input_file)",2445 "type": "object",2446 "required": false,2447 "enum": null,2448 "default": null,2449 "description": "A file input to the model."2450 }2451 ],2452 "status": [2453 "DOCUMENTED",2454 "LIVE_VERIFIED"2455 ],2456 "sources": [2457 {2458 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",2459 "retrieved_at": "2026-09-18"2460 },2461 {2462 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2463 "retrieved_at": "2026-09-18"2464 }2465 ],2466 "live_example": {2467 "id": "msg_0d1a3b13e2bf34dd006aade8ffb8bc87d2b391468751423de3",2468 "type": "message",2469 "status": "completed",2470 "content": [2471 {2472 "type": "input_text",2473 "text": "Reply with OK again."2474 }2475 ],2476 "role": "user"2477 }2478 },2479 {2480 "provider": "openai",2481 "object": "Input content parts (InputContent)",2482 "type_or_object_value": "input_text | input_image | input_file",2483 "description": "Content parts for input messages and tool outputs. input_image: image_url (URL or data URL) or file_id, detail low|high|auto|original; input_file: file_id | file_url | file_data(+filename), detail auto|low|high; prompt_cache_breakpoint {mode: explicit} on any part (GPT-5.6+).",2484 "fields": [2485 {2486 "field": "(input_text)",2487 "type": "object",2488 "required": false,2489 "enum": null,2490 "default": null,2491 "description": "A text input to the model."2492 },2493 {2494 "field": "(input_text).type",2495 "type": "string",2496 "required": true,2497 "enum": [2498 "input_text"2499 ],2500 "default": "input_text",2501 "description": "The type of the input item. Always `input_text`."2502 },2503 {2504 "field": "(input_text).text",2505 "type": "string",2506 "required": true,2507 "enum": null,2508 "default": null,2509 "description": "The text input to the model."2510 },2511 {2512 "field": "(input_text).prompt_cache_breakpoint",2513 "type": "object",2514 "required": false,2515 "enum": null,2516 "default": null,2517 "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block."2518 },2519 {2520 "field": "(input_text).prompt_cache_breakpoint.mode",2521 "type": "string",2522 "required": true,2523 "enum": [2524 "explicit"2525 ],2526 "default": "explicit",2527 "description": "The breakpoint mode. Always `explicit`."2528 },2529 {2530 "field": "(input_image)",2531 "type": "object",2532 "required": false,2533 "enum": null,2534 "default": null,2535 "description": "An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)."2536 },2537 {2538 "field": "(input_image).type",2539 "type": "string",2540 "required": true,2541 "enum": [2542 "input_image"2543 ],2544 "default": "input_image",2545 "description": "The type of the input item. Always `input_image`."2546 },2547 {2548 "field": "(input_image).image_url",2549 "type": "string | null",2550 "required": false,2551 "enum": null,2552 "default": null,2553 "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."2554 },2555 {2556 "field": "(input_image).file_id",2557 "type": "string | null",2558 "required": false,2559 "enum": null,2560 "default": null,2561 "description": "The ID of the file to be sent to the model."2562 },2563 {2564 "field": "(input_image).detail",2565 "type": "string",2566 "required": true,2567 "enum": [2568 "low",2569 "high",2570 "auto",2571 "original"2572 ],2573 "default": null,2574 "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`."2575 },2576 {2577 "field": "(input_image).prompt_cache_breakpoint",2578 "type": "object",2579 "required": false,2580 "enum": null,2581 "default": null,2582 "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block."2583 },2584 {2585 "field": "(input_image).prompt_cache_breakpoint.mode",2586 "type": "string",2587 "required": true,2588 "enum": [2589 "explicit"2590 ],2591 "default": "explicit",2592 "description": "The breakpoint mode. Always `explicit`."2593 },2594 {2595 "field": "(input_file)",2596 "type": "object",2597 "required": false,2598 "enum": null,2599 "default": null,2600 "description": "A file input to the model."2601 },2602 {2603 "field": "(input_file).type",2604 "type": "string",2605 "required": true,2606 "enum": [2607 "input_file"2608 ],2609 "default": "input_file",2610 "description": "The type of the input item. Always `input_file`."2611 },2612 {2613 "field": "(input_file).file_id",2614 "type": "string | null",2615 "required": false,2616 "enum": null,2617 "default": null,2618 "description": "The ID of the file to be sent to the model."2619 },2620 {2621 "field": "(input_file).filename",2622 "type": "string",2623 "required": false,2624 "enum": null,2625 "default": null,2626 "description": "The name of the file to be sent to the model."2627 },2628 {2629 "field": "(input_file).file_data",2630 "type": "string",2631 "required": false,2632 "enum": null,2633 "default": null,2634 "description": "The content of the file to be sent to the model."2635 },2636 {2637 "field": "(input_file).prompt_cache_breakpoint",2638 "type": "object",2639 "required": false,2640 "enum": null,2641 "default": null,2642 "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block."2643 },2644 {2645 "field": "(input_file).prompt_cache_breakpoint.mode",2646 "type": "string",2647 "required": true,2648 "enum": [2649 "explicit"2650 ],2651 "default": "explicit",2652 "description": "The breakpoint mode. Always `explicit`."2653 },2654 {2655 "field": "(input_file).file_url",2656 "type": "string",2657 "required": false,2658 "enum": null,2659 "default": null,2660 "description": "The URL of the file to be sent to the model."2661 },2662 {2663 "field": "(input_file).detail",2664 "type": "string",2665 "required": false,2666 "enum": [2667 "auto",2668 "low",2669 "high"2670 ],2671 "default": null,2672 "description": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`."2673 }2674 ],2675 "status": [2676 "DOCUMENTED",2677 "LIVE_VERIFIED"2678 ],2679 "sources": [2680 {2681 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",2682 "retrieved_at": "2026-09-18"2683 },2684 {2685 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2686 "retrieved_at": "2026-09-18"2687 }2688 ],2689 "live_example": {2690 "type": "input_image",2691 "image_url": "data:image/png;base64,iVBORw0KGgo...(1x1 png)",2692 "detail": "low"2693 }2694 },2695 {2696 "provider": "openai",2697 "object": "Input content part: input_audio",2698 "type_or_object_value": "type = \"input_audio\"",2699 "description": "Audio input part {input_audio: {data (base64), format: mp3|wav}} — accepted by audio-capable models.",2700 "fields": [2701 {2702 "field": "type",2703 "type": "string",2704 "required": true,2705 "enum": [2706 "input_audio"2707 ],2708 "description": ""2709 },2710 {2711 "field": "input_audio.data",2712 "type": "string",2713 "required": true,2714 "description": "Base64 audio"2715 },2716 {2717 "field": "input_audio.format",2718 "type": "string",2719 "required": true,2720 "enum": [2721 "mp3",2722 "wav"2723 ],2724 "description": ""2725 }2726 ],2727 "status": [2728 "DOCUMENTED",2729 "UNVERIFIED"2730 ],2731 "sources": [2732 {2733 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",2734 "retrieved_at": "2026-09-18"2735 },2736 {2737 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",2738 "retrieved_at": "2026-09-18"2739 }2740 ]2741 },2742 {2743 "provider": "openai",2744 "object": "Output item types (union OutputItem)",2745 "type_or_object_value": "output[].type",2746 "description": "All output item types in the OpenAPI OutputItem union; tool-call items are documented by the tools fragments.",2747 "fields": [2748 {2749 "field": "additional_tools",2750 "type": "object",2751 "required": false,2752 "description": ""2753 },2754 {2755 "field": "apply_patch_call",2756 "type": "object",2757 "required": false,2758 "description": ""2759 },2760 {2761 "field": "apply_patch_call_output",2762 "type": "object",2763 "required": false,2764 "description": ""2765 },2766 {2767 "field": "click",2768 "type": "object",2769 "required": false,2770 "description": ""2771 },2772 {2773 "field": "code_interpreter_call",2774 "type": "object",2775 "required": false,2776 "description": ""2777 },2778 {2779 "field": "compaction",2780 "type": "object",2781 "required": false,2782 "description": ""2783 },2784 {2785 "field": "computer_call",2786 "type": "object",2787 "required": false,2788 "description": ""2789 },2790 {2791 "field": "computer_call_output",2792 "type": "object",2793 "required": false,2794 "description": ""2795 },2796 {2797 "field": "container_reference",2798 "type": "object",2799 "required": false,2800 "description": ""2801 },2802 {2803 "field": "create_file",2804 "type": "object",2805 "required": false,2806 "description": ""2807 },2808 {2809 "field": "custom_tool_call",2810 "type": "object",2811 "required": false,2812 "description": ""2813 },2814 {2815 "field": "custom_tool_call_output",2816 "type": "object",2817 "required": false,2818 "description": ""2819 },2820 {2821 "field": "delete_file",2822 "type": "object",2823 "required": false,2824 "description": ""2825 },2826 {2827 "field": "direct",2828 "type": "object",2829 "required": false,2830 "description": ""2831 },2832 {2833 "field": "double_click",2834 "type": "object",2835 "required": false,2836 "description": ""2837 },2838 {2839 "field": "drag",2840 "type": "object",2841 "required": false,2842 "description": ""2843 },2844 {2845 "field": "file_search_call",2846 "type": "object",2847 "required": false,2848 "description": ""2849 },2850 {2851 "field": "find_in_page",2852 "type": "object",2853 "required": false,2854 "description": ""2855 },2856 {2857 "field": "function_call",2858 "type": "object",2859 "required": false,2860 "description": ""2861 },2862 {2863 "field": "function_call_output",2864 "type": "object",2865 "required": false,2866 "description": ""2867 },2868 {2869 "field": "http_error",2870 "type": "object",2871 "required": false,2872 "description": ""2873 },2874 {2875 "field": "image_generation_call",2876 "type": "object",2877 "required": false,2878 "description": ""2879 },2880 {2881 "field": "keypress",2882 "type": "object",2883 "required": false,2884 "description": ""2885 },2886 {2887 "field": "local",2888 "type": "object",2889 "required": false,2890 "description": ""2891 },2892 {2893 "field": "local_shell_call",2894 "type": "object",2895 "required": false,2896 "description": ""2897 },2898 {2899 "field": "local_shell_call_output",2900 "type": "object",2901 "required": false,2902 "description": ""2903 },2904 {2905 "field": "mcp_approval_request",2906 "type": "object",2907 "required": false,2908 "description": ""2909 },2910 {2911 "field": "mcp_approval_response",2912 "type": "object",2913 "required": false,2914 "description": ""2915 },2916 {2917 "field": "mcp_call",2918 "type": "object",2919 "required": false,2920 "description": ""2921 },2922 {2923 "field": "mcp_list_tools",2924 "type": "object",2925 "required": false,2926 "description": ""2927 },2928 {2929 "field": "mcp_protocol_error",2930 "type": "object",2931 "required": false,2932 "description": ""2933 },2934 {2935 "field": "mcp_tool_execution_error",2936 "type": "object",2937 "required": false,2938 "description": ""2939 },2940 {2941 "field": "message",2942 "type": "object",2943 "required": false,2944 "description": ""2945 },2946 {2947 "field": "move",2948 "type": "object",2949 "required": false,2950 "description": ""2951 },2952 {2953 "field": "open_page",2954 "type": "object",2955 "required": false,2956 "description": ""2957 },2958 {2959 "field": "program",2960 "type": "object",2961 "required": false,2962 "description": ""2963 },2964 {2965 "field": "program_output",2966 "type": "object",2967 "required": false,2968 "description": ""2969 },2970 {2971 "field": "reasoning",2972 "type": "object",2973 "required": false,2974 "description": ""2975 },2976 {2977 "field": "screenshot",2978 "type": "object",2979 "required": false,2980 "description": ""2981 },2982 {2983 "field": "scroll",2984 "type": "object",2985 "required": false,2986 "description": ""2987 },2988 {2989 "field": "search",2990 "type": "object",2991 "required": false,2992 "description": ""2993 },2994 {2995 "field": "shell_call",2996 "type": "object",2997 "required": false,2998 "description": ""2999 },3000 {3001 "field": "shell_call_output",3002 "type": "object",3003 "required": false,3004 "description": ""3005 },3006 {3007 "field": "tool_search_call",3008 "type": "object",3009 "required": false,3010 "description": ""3011 },3012 {3013 "field": "tool_search_output",3014 "type": "object",3015 "required": false,3016 "description": ""3017 },3018 {3019 "field": "type",3020 "type": "object",3021 "required": false,3022 "description": ""3023 },3024 {3025 "field": "update_file",3026 "type": "object",3027 "required": false,3028 "description": ""3029 },3030 {3031 "field": "wait",3032 "type": "object",3033 "required": false,3034 "description": ""3035 },3036 {3037 "field": "web_search_call",3038 "type": "object",3039 "required": false,3040 "description": ""3041 }3042 ],3043 "status": [3044 "DOCUMENTED"3045 ],3046 "sources": [3047 {3048 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",3049 "retrieved_at": "2026-09-18"3050 },3051 {3052 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",3053 "retrieved_at": "2026-09-18"3054 }3055 ],3056 "notes": "Live observed: message, reasoning, compaction (from /responses/compact)."3057 },3058 {3059 "provider": "openai",3060 "object": "Item types (union Item, usable as input)",3061 "type_or_object_value": "input[].type",3062 "description": "All item types accepted in `input`/conversation items.",3063 "fields": [3064 {3065 "field": "additional_tools",3066 "type": "object",3067 "required": false,3068 "description": ""3069 },3070 {3071 "field": "apply_patch_call",3072 "type": "object",3073 "required": false,3074 "description": ""3075 },3076 {3077 "field": "apply_patch_call_output",3078 "type": "object",3079 "required": false,3080 "description": ""3081 },3082 {3083 "field": "click",3084 "type": "object",3085 "required": false,3086 "description": ""3087 },3088 {3089 "field": "code_interpreter_call",3090 "type": "object",3091 "required": false,3092 "description": ""3093 },3094 {3095 "field": "compaction",3096 "type": "object",3097 "required": false,3098 "description": ""3099 },3100 {3101 "field": "computer_call",3102 "type": "object",3103 "required": false,3104 "description": ""3105 },3106 {3107 "field": "computer_call_output",3108 "type": "object",3109 "required": false,3110 "description": ""3111 },3112 {3113 "field": "configuration_update",3114 "type": "object",3115 "required": false,3116 "description": ""3117 },3118 {3119 "field": "container_reference",3120 "type": "object",3121 "required": false,3122 "description": ""3123 },3124 {3125 "field": "create_file",3126 "type": "object",3127 "required": false,3128 "description": ""3129 },3130 {3131 "field": "custom_tool_call",3132 "type": "object",3133 "required": false,3134 "description": ""3135 },3136 {3137 "field": "custom_tool_call_output",3138 "type": "object",3139 "required": false,3140 "description": ""3141 },3142 {3143 "field": "delete_file",3144 "type": "object",3145 "required": false,3146 "description": ""3147 },3148 {3149 "field": "direct",3150 "type": "object",3151 "required": false,3152 "description": ""3153 },3154 {3155 "field": "double_click",3156 "type": "object",3157 "required": false,3158 "description": ""3159 },3160 {3161 "field": "drag",3162 "type": "object",3163 "required": false,3164 "description": ""3165 },3166 {3167 "field": "file_search_call",3168 "type": "object",3169 "required": false,3170 "description": ""3171 },3172 {3173 "field": "find_in_page",3174 "type": "object",3175 "required": false,3176 "description": ""3177 },3178 {3179 "field": "function_call",3180 "type": "object",3181 "required": false,3182 "description": ""3183 },3184 {3185 "field": "function_call_output",3186 "type": "object",3187 "required": false,3188 "description": ""3189 },3190 {3191 "field": "http_error",3192 "type": "object",3193 "required": false,3194 "description": ""3195 },3196 {3197 "field": "image_generation_call",3198 "type": "object",3199 "required": false,3200 "description": ""3201 },3202 {3203 "field": "keypress",3204 "type": "object",3205 "required": false,3206 "description": ""3207 },3208 {3209 "field": "local",3210 "type": "object",3211 "required": false,3212 "description": ""3213 },3214 {3215 "field": "local_shell_call",3216 "type": "object",3217 "required": false,3218 "description": ""3219 },3220 {3221 "field": "local_shell_call_output",3222 "type": "object",3223 "required": false,3224 "description": ""3225 },3226 {3227 "field": "mcp_approval_request",3228 "type": "object",3229 "required": false,3230 "description": ""3231 },3232 {3233 "field": "mcp_approval_response",3234 "type": "object",3235 "required": false,3236 "description": ""3237 },3238 {3239 "field": "mcp_call",3240 "type": "object",3241 "required": false,3242 "description": ""3243 },3244 {3245 "field": "mcp_list_tools",3246 "type": "object",3247 "required": false,3248 "description": ""3249 },3250 {3251 "field": "mcp_protocol_error",3252 "type": "object",3253 "required": false,3254 "description": ""3255 },3256 {3257 "field": "mcp_tool_execution_error",3258 "type": "object",3259 "required": false,3260 "description": ""3261 },3262 {3263 "field": "message",3264 "type": "object",3265 "required": false,3266 "description": ""3267 },3268 {3269 "field": "move",3270 "type": "object",3271 "required": false,3272 "description": ""3273 },3274 {3275 "field": "open_page",3276 "type": "object",3277 "required": false,3278 "description": ""3279 },3280 {3281 "field": "program",3282 "type": "object",3283 "required": false,3284 "description": ""3285 },3286 {3287 "field": "reasoning",3288 "type": "object",3289 "required": false,3290 "description": ""3291 },3292 {3293 "field": "screenshot",3294 "type": "object",3295 "required": false,3296 "description": ""3297 },3298 {3299 "field": "scroll",3300 "type": "object",3301 "required": false,3302 "description": ""3303 },3304 {3305 "field": "search",3306 "type": "object",3307 "required": false,3308 "description": ""3309 },3310 {3311 "field": "shell_call",3312 "type": "object",3313 "required": false,3314 "description": ""3315 },3316 {3317 "field": "shell_call_output",3318 "type": "object",3319 "required": false,3320 "description": ""3321 },3322 {3323 "field": "tool_search_call",3324 "type": "object",3325 "required": false,3326 "description": ""3327 },3328 {3329 "field": "tool_search_output",3330 "type": "object",3331 "required": false,3332 "description": ""3333 },3334 {3335 "field": "type",3336 "type": "object",3337 "required": false,3338 "description": ""3339 },3340 {3341 "field": "update_file",3342 "type": "object",3343 "required": false,3344 "description": ""3345 },3346 {3347 "field": "wait",3348 "type": "object",3349 "required": false,3350 "description": ""3351 },3352 {3353 "field": "web_search_call",3354 "type": "object",3355 "required": false,3356 "description": ""3357 }3358 ],3359 "status": [3360 "DOCUMENTED"3361 ],3362 "sources": [3363 {3364 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",3365 "retrieved_at": "2026-09-18"3366 },3367 {3368 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",3369 "retrieved_at": "2026-09-18"3370 }3371 ]3372 },3373 {3374 "provider": "openai",3375 "object": "ResponseItemList",3376 "type_or_object_value": "object = \"list\"",3377 "description": "Paginated list returned by GET /v1/responses/{id}/input_items.",3378 "fields": [3379 {3380 "field": "object",3381 "type": "string",3382 "required": true,3383 "enum": [3384 "list"3385 ],3386 "default": null,3387 "description": "The type of object returned, must be `list`."3388 },3389 {3390 "field": "data",3391 "type": "array<object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<program> | object<program_output> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call> | object<custom_tool_call_output>>",3392 "required": true,3393 "enum": null,3394 "default": null,3395 "description": "A list of items used to generate this response."3396 },3397 {3398 "field": "data[]",3399 "type": "object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<program> | object<program_output> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call> | object<custom_tool_call_output>",3400 "required": false,3401 "enum": null,3402 "default": null,3403 "description": "Content item used to generate a response."3404 },3405 {3406 "field": "has_more",3407 "type": "boolean",3408 "required": true,3409 "enum": null,3410 "default": null,3411 "description": "Whether there are more items available."3412 },3413 {3414 "field": "first_id",3415 "type": "string",3416 "required": true,3417 "enum": null,3418 "default": null,3419 "description": "The ID of the first item in the list."3420 },3421 {3422 "field": "last_id",3423 "type": "string",3424 "required": true,3425 "enum": null,3426 "default": null,3427 "description": "The ID of the last item in the list."3428 }3429 ],3430 "status": [3431 "DOCUMENTED",3432 "LIVE_VERIFIED"3433 ],3434 "sources": [3435 {3436 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",3437 "retrieved_at": "2026-09-18"3438 },3439 {3440 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",3441 "retrieved_at": "2026-09-18"3442 }3443 ],3444 "live_example": {3445 "object": "list",3446 "data": [3447 {3448 "id": "msg_0d1a3b13e2bf34dd006aade8ffb8bc87d2b391468751423de3",3449 "type": "message",3450 "status": "completed",3451 "content": [3452 {3453 "type": "input_text",3454 "text": "Reply with OK again."3455 }3456 ],3457 "role": "user"3458 },3459 {3460 "id": "msg_0d1a3b13e2bf34dd006aade8fdd89c87d290d9a0f6c0dfc081",3461 "type": "message",3462 "status": "completed",3463 "content": [3464 {3465 "type": "output_text",3466 "annotations": [],3467 "logprobs": [],3468 "text": "OK."3469 }3470 ],3471 "phase": "final_answer",3472 "role": "assistant"3473 },3474 {3475 "id": "msg_0d1a3b13e2bf34dd006aade8fd836887d2a3fa8a30de5ef805",3476 "type": "message",3477 "status": "completed",3478 "content": [3479 {3480 "type": "input_text",3481 "text": "Reply with OK."3482 }3483 ],3484 "role": "user"3485 }3486 ],3487 "first_id": "msg_0d1a3b13e2bf34dd006aade8ffb8bc87d2b391468751423de3",3488 "has_more": false,3489 "last_id": "msg_0d1a3b13e2bf34dd006aade8fd836887d2a3fa8a30de5ef805"3490 }3491 },3492 {3493 "provider": "openai",3494 "object": "TokenCountsResource",3495 "type_or_object_value": "object = \"response.input_tokens\"",3496 "description": "Result of POST /v1/responses/input_tokens.",3497 "fields": [3498 {3499 "field": "object",3500 "type": "string",3501 "required": true,3502 "enum": [3503 "response.input_tokens"3504 ],3505 "default": "response.input_tokens",3506 "description": ""3507 },3508 {3509 "field": "input_tokens",3510 "type": "integer",3511 "required": true,3512 "enum": null,3513 "default": null,3514 "description": ""3515 }3516 ],3517 "status": [3518 "DOCUMENTED",3519 "LIVE_VERIFIED"3520 ],3521 "sources": [3522 {3523 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",3524 "retrieved_at": "2026-09-18"3525 },3526 {3527 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",3528 "retrieved_at": "2026-09-18"3529 }3530 ],3531 "live_example": {3532 "object": "response.input_tokens",3533 "input_tokens": 103534 }3535 },3536 {3537 "provider": "openai",3538 "object": "CompactResource",3539 "type_or_object_value": "object = \"response.compaction\"",3540 "description": "Result of POST /v1/responses/compact: id (resp_...), created_at, output[] (retained items + compaction item cmp_...), usage.",3541 "fields": [3542 {3543 "field": "id",3544 "type": "string",3545 "required": true,3546 "enum": null,3547 "default": null,3548 "description": "The unique identifier for the compacted response."3549 },3550 {3551 "field": "object",3552 "type": "string",3553 "required": true,3554 "enum": [3555 "response.compaction"3556 ],3557 "default": "response.compaction",3558 "description": "The object type. Always `response.compaction`."3559 },3560 {3561 "field": "output",3562 "type": "array<object<message> | object<program> | object<program_output> | object<function_call> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<function_call_output> | object<file_search_call> | object<web_search_call> | object<image_generation_call> | object<computer_call> | object<computer_call_output> | object<reasoning> | object<compaction> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call> | object<custom_tool_call_output>>",3563 "required": true,3564 "enum": null,3565 "default": null,3566 "description": "The compacted list of output items."3567 },3568 {3569 "field": "created_at",3570 "type": "integer",3571 "required": true,3572 "enum": null,3573 "default": null,3574 "description": "Unix timestamp (in seconds) when the compacted conversation was created."3575 },3576 {3577 "field": "usage",3578 "type": "object",3579 "required": true,3580 "enum": null,3581 "default": null,3582 "description": "Token accounting for the compaction pass, including cached, reasoning, and total tokens."3583 },3584 {3585 "field": "usage.input_tokens",3586 "type": "integer",3587 "required": true,3588 "enum": null,3589 "default": null,3590 "description": "The number of input tokens."3591 },3592 {3593 "field": "usage.input_tokens_details",3594 "type": "object",3595 "required": true,3596 "enum": null,3597 "default": null,3598 "description": "A detailed breakdown of the input tokens."3599 },3600 {3601 "field": "usage.output_tokens",3602 "type": "integer",3603 "required": true,3604 "enum": null,3605 "default": null,3606 "description": "The number of output tokens."3607 },3608 {3609 "field": "usage.output_tokens_details",3610 "type": "object",3611 "required": true,3612 "enum": null,3613 "default": null,3614 "description": "A detailed breakdown of the output tokens."3615 },3616 {3617 "field": "usage.total_tokens",3618 "type": "integer",3619 "required": true,3620 "enum": null,3621 "default": null,3622 "description": "The total number of tokens used."3623 }3624 ],3625 "status": [3626 "DOCUMENTED",3627 "LIVE_VERIFIED"3628 ],3629 "sources": [3630 {3631 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",3632 "retrieved_at": "2026-09-18"3633 },3634 {3635 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",3636 "retrieved_at": "2026-09-18"3637 }3638 ],3639 "live_example": {3640 "id": "resp_0ed5b67e8da655fb016aade904482087d288ab999264156e43",3641 "object": "response.compaction",3642 "created_at": 1789782277,3643 "output": [3644 {3645 "id": "msg_0ed5b67e8da655fb016aade9044d6087d2a639312c73757f0e",3646 "type": "message",3647 "status": "completed",3648 "content": [3649 {3650 "type": "input_text",3651 "text": "Reply with OK."3652 }3653 ],3654 "role": "user"3655 },3656 {3657 "id": "msg_0ed5b67e8da655fb016aade9044da087d2b842c4f1437ae3d5",3658 "type": "message",3659 "status": "completed",3660 "content": [3661 {3662 "type": "input_text",3663 "text": "Reply with OK again."3664 }3665 ],3666 "role": "user"3667 },3668 {3669 "id": "cmp_0ed5b67e8da655fb016aade904992087d2a7f4f8dbfac97dfa",3670 "type": "compaction",3671 "encrypted_content": "gAAAAABqrekFMDjkZ64ju-Up...(truncated)"3672 }3673 ],3674 "usage": {3675 "input_tokens": 119,3676 "input_tokens_details": {3677 "cache_write_tokens": 0,3678 "cached_tokens": 03679 },3680 "output_tokens": 217,3681 "output_tokens_details": {3682 "reasoning_tokens": 03683 },3684 "total_tokens": 3363685 }3686 }3687 },3688 {3689 "provider": "openai",3690 "object": "ConversationResource",3691 "type_or_object_value": "object = \"conversation\"",3692 "description": "Conversation object.",3693 "fields": [3694 {3695 "field": "id",3696 "type": "string",3697 "required": true,3698 "enum": null,3699 "default": null,3700 "description": "The unique ID of the conversation."3701 },3702 {3703 "field": "object",3704 "type": "string",3705 "required": true,3706 "enum": [3707 "conversation"3708 ],3709 "default": "conversation",3710 "description": "The object type, which is always `conversation`."3711 },3712 {3713 "field": "metadata",3714 "type": "any",3715 "required": true,3716 "enum": null,3717 "default": null,3718 "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters."3719 },3720 {3721 "field": "created_at",3722 "type": "integer",3723 "required": true,3724 "enum": null,3725 "default": null,3726 "description": "The time at which the conversation was created, measured in seconds since the Unix epoch."3727 }3728 ],3729 "status": [3730 "DOCUMENTED",3731 "LIVE_VERIFIED"3732 ],3733 "sources": [3734 {3735 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",3736 "retrieved_at": "2026-09-18"3737 },3738 {3739 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",3740 "retrieved_at": "2026-09-18"3741 }3742 ],3743 "live_example": {3744 "id": "conv_6aade90dfa208197bf48e4e09c95ce8104b7a5ba78eb9ec2",3745 "object": "conversation",3746 "created_at": 1789782285,3747 "metadata": {3748 "atlas": "openai-core"3749 }3750 }3751 },3752 {3753 "provider": "openai",3754 "object": "ConversationItemList",3755 "type_or_object_value": "object = \"list\"",3756 "description": "Paginated conversation items.",3757 "fields": [3758 {3759 "field": "object",3760 "type": "string",3761 "required": true,3762 "enum": [3763 "list"3764 ],3765 "default": null,3766 "description": "The type of object returned, must be `list`."3767 },3768 {3769 "field": "data",3770 "type": "array<object<message> | object<function_call> | object<function_call_output> | object<file_search_call> | object<web_search_call> | object<image_generation_call> | object<computer_call> | object<computer_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<program> | object<program_output> | object<compaction> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call> | object<custom_tool_call_output>>",3771 "required": true,3772 "enum": null,3773 "default": null,3774 "description": "A list of conversation items."3775 },3776 {3777 "field": "data[]",3778 "type": "object<message> | object<function_call> | object<function_call_output> | object<file_search_call> | object<web_search_call> | object<image_generation_call> | object<computer_call> | object<computer_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<program> | object<program_output> | object<compaction> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call> | object<custom_tool_call_output>",3779 "required": false,3780 "enum": null,3781 "default": null,3782 "description": "A single item within a conversation. The set of possible types are the same as the `output` type of a [Response object](https://developers.openai.com/api/reference/resources/responses#%28resource%29%20responses%20%3E%20%28model%29%20response%20%3E%20%28schema%29%20%3E%20%28property%29%20output)."3783 },3784 {3785 "field": "has_more",3786 "type": "boolean",3787 "required": true,3788 "enum": null,3789 "default": null,3790 "description": "Whether there are more items available."3791 },3792 {3793 "field": "first_id",3794 "type": "string",3795 "required": true,3796 "enum": null,3797 "default": null,3798 "description": "The ID of the first item in the list."3799 },3800 {3801 "field": "last_id",3802 "type": "string",3803 "required": true,3804 "enum": null,3805 "default": null,3806 "description": "The ID of the last item in the list."3807 }3808 ],3809 "status": [3810 "DOCUMENTED",3811 "LIVE_VERIFIED"3812 ],3813 "sources": [3814 {3815 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",3816 "retrieved_at": "2026-09-18"3817 },3818 {3819 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",3820 "retrieved_at": "2026-09-18"3821 }3822 ],3823 "live_example": {3824 "object": "list",3825 "data": [3826 {3827 "id": "msg_6aade90e86588197a6134f717609bef004b7a5ba78eb9ec2",3828 "type": "message",3829 "status": "completed",3830 "content": [3831 {3832 "type": "input_text",3833 "text": "Reply with OK."3834 }3835 ],3836 "role": "user"3837 },3838 {3839 "id": "msg_04b7a5ba78eb9ec2006aade91073b881978d735ac54c02f920",3840 "type": "message",3841 "status": "completed",3842 "content": [3843 {3844 "type": "input_text",3845 "text": "Reply with OK once more."3846 }3847 ],3848 "role": "user"3849 },3850 {3851 "id": "msg_04b7a5ba78eb9ec2006aade910bad48197878d60a9a894a80b",3852 "type": "message",3853 "status": "completed",3854 "content": [3855 {3856 "type": "output_text",3857 "annotations": [],3858 "logprobs": [],3859 "text": "OK"3860 }3861 ],3862 "role": "assistant"3863 }3864 ],3865 "first_id": "msg_6aade90e86588197a6134f717609bef004b7a5ba78eb9ec2",3866 "has_more": false,3867 "last_id": "msg_04b7a5ba78eb9ec2006aade910bad48197878d60a9a894a80b"3868 }3869 },3870 {3871 "provider": "openai",3872 "object": "DeletedConversationResource",3873 "type_or_object_value": "object = \"conversation.deleted\"",3874 "description": "Delete confirmation.",3875 "fields": [3876 {3877 "field": "object",3878 "type": "string",3879 "required": true,3880 "enum": [3881 "conversation.deleted"3882 ],3883 "default": "conversation.deleted",3884 "description": ""3885 },3886 {3887 "field": "deleted",3888 "type": "boolean",3889 "required": true,3890 "enum": null,3891 "default": null,3892 "description": ""3893 },3894 {3895 "field": "id",3896 "type": "string",3897 "required": true,3898 "enum": null,3899 "default": null,3900 "description": ""3901 }3902 ],3903 "status": [3904 "DOCUMENTED",3905 "LIVE_VERIFIED"3906 ],3907 "sources": [3908 {3909 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",3910 "retrieved_at": "2026-09-18"3911 },3912 {3913 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",3914 "retrieved_at": "2026-09-18"3915 }3916 ],3917 "live_example": {3918 "id": "conv_6aade90dfa208197bf48e4e09c95ce8104b7a5ba78eb9ec2",3919 "object": "conversation.deleted",3920 "deleted": true3921 }3922 },3923 {3924 "provider": "openai",3925 "object": "Chat completion (CreateChatCompletionResponse)",3926 "type_or_object_value": "object = \"chat.completion\"",3927 "description": "Chat Completions result: choices[].message{role, content, refusal, annotations, tool_calls, audio}, finish_reason, logprobs; usage (CompletionUsage); service_tier; system_fingerprint (deprecated).",3928 "fields": [3929 {3930 "field": "id",3931 "type": "string",3932 "required": true,3933 "enum": null,3934 "default": null,3935 "description": "A unique identifier for the chat completion."3936 },3937 {3938 "field": "choices",3939 "type": "array<object>",3940 "required": true,3941 "enum": null,3942 "default": null,3943 "description": "A list of chat completion choices. Can be more than one if `n` is greater than 1."3944 },3945 {3946 "field": "choices[]",3947 "type": "object",3948 "required": false,3949 "enum": null,3950 "default": null,3951 "description": ""3952 },3953 {3954 "field": "choices[].finish_reason",3955 "type": "string",3956 "required": true,3957 "enum": [3958 "stop",3959 "length",3960 "tool_calls",3961 "content_filter",3962 "function_call"3963 ],3964 "default": null,3965 "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. R"3966 },3967 {3968 "field": "choices[].index",3969 "type": "integer",3970 "required": true,3971 "enum": null,3972 "default": null,3973 "description": "The index of the choice in the list of choices."3974 },3975 {3976 "field": "choices[].message",3977 "type": "object",3978 "required": true,3979 "enum": null,3980 "default": null,3981 "description": "A chat completion message generated by the model."3982 },3983 {3984 "field": "choices[].message.content",3985 "type": "string | null",3986 "required": true,3987 "enum": null,3988 "default": null,3989 "description": "The contents of the message."3990 },3991 {3992 "field": "choices[].message.refusal",3993 "type": "string | null",3994 "required": true,3995 "enum": null,3996 "default": null,3997 "description": "The refusal message generated by the model."3998 },3999 {4000 "field": "choices[].message.tool_calls",4001 "type": "array<object<function> | object<custom>>",4002 "required": false,4003 "enum": null,4004 "default": null,4005 "description": "The tool calls generated by the model, such as function calls."4006 },4007 {4008 "field": "choices[].message.annotations",4009 "type": "array<object>",4010 "required": false,4011 "enum": null,4012 "default": null,4013 "description": "Annotations for the message, when applicable, as when using the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search)."4014 },4015 {4016 "field": "choices[].message.role",4017 "type": "string",4018 "required": true,4019 "enum": [4020 "assistant"4021 ],4022 "default": null,4023 "description": "The role of the author of this message."4024 },4025 {4026 "field": "choices[].message.function_call",4027 "type": "object",4028 "required": false,4029 "enum": null,4030 "default": null,4031 "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.",4032 "deprecated": true4033 },4034 {4035 "field": "choices[].message.audio",4036 "type": "object | null",4037 "required": false,4038 "enum": null,4039 "default": null,4040 "description": "If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](https://developers.openai.com/api/docs/guides/audio)."4041 },4042 {4043 "field": "choices[].logprobs",4044 "type": "object | null",4045 "required": true,4046 "enum": null,4047 "default": null,4048 "description": "Log probability information for the choice."4049 },4050 {4051 "field": "choices[].logprobs.content",4052 "type": "array<object>",4053 "required": true,4054 "enum": null,4055 "default": null,4056 "description": "A list of message content tokens with log probability information."4057 },4058 {4059 "field": "choices[].logprobs.refusal",4060 "type": "array<object>",4061 "required": true,4062 "enum": null,4063 "default": null,4064 "description": "A list of message refusal tokens with log probability information."4065 },4066 {4067 "field": "created",4068 "type": "integer",4069 "required": true,4070 "enum": null,4071 "default": null,4072 "description": "The Unix timestamp (in seconds) of when the chat completion was created."4073 },4074 {4075 "field": "model",4076 "type": "string",4077 "required": true,4078 "enum": null,4079 "default": null,4080 "description": "The model used for the chat completion."4081 },4082 {4083 "field": "metadata",4084 "type": "map<string,string>",4085 "required": false,4086 "enum": null,4087 "default": null,4088 "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters."4089 },4090 {4091 "field": "service_tier",4092 "type": "string | null",4093 "required": false,4094 "enum": [4095 "auto",4096 "default",4097 "flex",4098 "scale",4099 "priority",4100 "fast"4101 ],4102 "default": "auto",4103 "description": "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.ope"4104 },4105 {4106 "field": "system_fingerprint",4107 "type": "string",4108 "required": false,4109 "enum": null,4110 "default": null,4111 "description": "This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.",4112 "deprecated": true4113 },4114 {4115 "field": "object",4116 "type": "string",4117 "required": true,4118 "enum": [4119 "chat.completion"4120 ],4121 "default": null,4122 "description": "The object type, which is always `chat.completion`."4123 },4124 {4125 "field": "usage",4126 "type": "object",4127 "required": false,4128 "enum": null,4129 "default": null,4130 "description": "Usage statistics for the completion request."4131 },4132 {4133 "field": "usage.completion_tokens",4134 "type": "integer",4135 "required": true,4136 "enum": null,4137 "default": 0,4138 "description": "Number of tokens in the generated completion."4139 },4140 {4141 "field": "usage.prompt_tokens",4142 "type": "integer",4143 "required": true,4144 "enum": null,4145 "default": 0,4146 "description": "Number of tokens in the prompt."4147 },4148 {4149 "field": "usage.total_tokens",4150 "type": "integer",4151 "required": true,4152 "enum": null,4153 "default": 0,4154 "description": "Total number of tokens used in the request (prompt + completion)."4155 },4156 {4157 "field": "usage.completion_tokens_details",4158 "type": "object",4159 "required": false,4160 "enum": null,4161 "default": null,4162 "description": "Breakdown of tokens used in a completion."4163 },4164 {4165 "field": "usage.completion_tokens_details.accepted_prediction_tokens",4166 "type": "integer",4167 "required": false,4168 "enum": null,4169 "default": 0,4170 "description": "When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion."4171 },4172 {4173 "field": "usage.completion_tokens_details.audio_tokens",4174 "type": "integer",4175 "required": false,4176 "enum": null,4177 "default": 0,4178 "description": "Audio input tokens generated by the model."4179 },4180 {4181 "field": "usage.completion_tokens_details.reasoning_tokens",4182 "type": "integer",4183 "required": false,4184 "enum": null,4185 "default": 0,4186 "description": "Tokens generated by the model for reasoning."4187 },4188 {4189 "field": "usage.completion_tokens_details.text_tokens",4190 "type": "integer",4191 "required": false,4192 "enum": null,4193 "default": null,4194 "description": "Text output tokens generated by the model."4195 },4196 {4197 "field": "usage.completion_tokens_details.rejected_prediction_tokens",4198 "type": "integer",4199 "required": false,4200 "enum": null,4201 "default": 0,4202 "description": "When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits."4203 },4204 {4205 "field": "usage.prompt_tokens_details",4206 "type": "object",4207 "required": false,4208 "enum": null,4209 "default": null,4210 "description": "Breakdown of tokens used in the prompt."4211 },4212 {4213 "field": "usage.prompt_tokens_details.audio_tokens",4214 "type": "integer",4215 "required": false,4216 "enum": null,4217 "default": 0,4218 "description": "Audio input tokens present in the prompt."4219 },4220 {4221 "field": "usage.prompt_tokens_details.cached_tokens",4222 "type": "integer",4223 "required": false,4224 "enum": null,4225 "default": 0,4226 "description": "Cached tokens present in the prompt."4227 },4228 {4229 "field": "usage.prompt_tokens_details.text_tokens",4230 "type": "integer",4231 "required": false,4232 "enum": null,4233 "default": null,4234 "description": "Text input tokens present in the prompt."4235 },4236 {4237 "field": "usage.prompt_tokens_details.image_tokens",4238 "type": "integer",4239 "required": false,4240 "enum": null,4241 "default": null,4242 "description": "Image input tokens present in the prompt."4243 },4244 {4245 "field": "usage.prompt_tokens_details.cache_write_tokens",4246 "type": "integer",4247 "required": false,4248 "enum": null,4249 "default": 0,4250 "description": "The unadjusted number of prompt tokens written to cache."4251 },4252 {4253 "field": "moderation",4254 "type": "object | null",4255 "required": false,4256 "enum": null,4257 "default": null,4258 "description": "Moderation results for the request input and generated output, if moderated completions were requested."4259 },4260 {4261 "field": "moderation.input",4262 "type": "object<moderation_results> | object<error>",4263 "required": true,4264 "enum": null,4265 "default": null,4266 "description": "Moderation for the request input."4267 },4268 {4269 "field": "moderation.input(moderation_results)",4270 "type": "object",4271 "required": true,4272 "enum": null,4273 "default": null,4274 "description": "Successful moderation results for the request input or generated output."4275 },4276 {4277 "field": "moderation.input(error)",4278 "type": "object",4279 "required": true,4280 "enum": null,4281 "default": null,4282 "description": "An error produced while attempting moderation."4283 },4284 {4285 "field": "moderation.output",4286 "type": "object<moderation_results> | object<error>",4287 "required": true,4288 "enum": null,4289 "default": null,4290 "description": "Moderation for the generated output."4291 },4292 {4293 "field": "moderation.output(moderation_results)",4294 "type": "object",4295 "required": true,4296 "enum": null,4297 "default": null,4298 "description": "Successful moderation results for the request input or generated output."4299 },4300 {4301 "field": "moderation.output(error)",4302 "type": "object",4303 "required": true,4304 "enum": null,4305 "default": null,4306 "description": "An error produced while attempting moderation."4307 }4308 ],4309 "status": [4310 "DOCUMENTED",4311 "LIVE_VERIFIED"4312 ],4313 "sources": [4314 {4315 "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",4316 "retrieved_at": "2026-09-18"4317 },4318 {4319 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",4320 "retrieved_at": "2026-09-18"4321 }4322 ],4323 "live_example": {4324 "id": "chatcmpl-EPeQHZhkba6K4Tw2J4h0LJHJfsvbv",4325 "object": "chat.completion",4326 "created": 1789782293,4327 "model": "gpt-4.1-nano-2025-04-14",4328 "choices": [4329 {4330 "index": 0,4331 "message": {4332 "role": "assistant",4333 "content": "OK",4334 "refusal": null,4335 "annotations": []4336 },4337 "logprobs": null,4338 "finish_reason": "stop"4339 }4340 ],4341 "usage": {4342 "prompt_tokens": 11,4343 "completion_tokens": 1,4344 "total_tokens": 12,4345 "prompt_tokens_details": {4346 "cached_tokens": 0,4347 "audio_tokens": 04348 },4349 "completion_tokens_details": {4350 "reasoning_tokens": 0,4351 "audio_tokens": 0,4352 "accepted_prediction_tokens": 0,4353 "rejected_prediction_tokens": 04354 }4355 },4356 "service_tier": "default",4357 "system_fingerprint": "fp_6afed20c8d"4358 },4359 "live_fields_not_in_spec": [4360 "frequency_penalty",4361 "input_user",4362 "metadata",4363 "presence_penalty",4364 "request_id",4365 "response_format",4366 "seed",4367 "temperature",4368 "tool_choice",4369 "tools",4370 "top_p"4371 ],4372 "live_notes": "Extra fields appear on GET /v1/chat/completions/{id} (stored request echo): request_id, input_user, seed, temperature, top_p, presence_penalty, frequency_penalty, tool_choice, tools, response_format, metadata."4373 },4374 {4375 "provider": "openai",4376 "object": "Chat completion message (ChatCompletionResponseMessage)",4377 "type_or_object_value": "choices[].message",4378 "description": "Assistant message in a chat completion.",4379 "fields": [4380 {4381 "field": "content",4382 "type": "string | null",4383 "required": true,4384 "enum": null,4385 "default": null,4386 "description": "The contents of the message."4387 },4388 {4389 "field": "refusal",4390 "type": "string | null",4391 "required": true,4392 "enum": null,4393 "default": null,4394 "description": "The refusal message generated by the model."4395 },4396 {4397 "field": "tool_calls",4398 "type": "array<object<function> | object<custom>>",4399 "required": false,4400 "enum": null,4401 "default": null,4402 "description": "The tool calls generated by the model, such as function calls."4403 },4404 {4405 "field": "tool_calls[]",4406 "type": "object<function> | object<custom>",4407 "required": false,4408 "enum": null,4409 "default": null,4410 "description": ""4411 },4412 {4413 "field": "tool_calls[](function)",4414 "type": "object",4415 "required": false,4416 "enum": null,4417 "default": null,4418 "description": "A call to a function tool created by the model."4419 },4420 {4421 "field": "tool_calls[](function).id",4422 "type": "string",4423 "required": true,4424 "enum": null,4425 "default": null,4426 "description": "The ID of the tool call."4427 },4428 {4429 "field": "tool_calls[](function).type",4430 "type": "string",4431 "required": true,4432 "enum": [4433 "function"4434 ],4435 "default": null,4436 "description": "The type of the tool. Currently, only `function` is supported."4437 },4438 {4439 "field": "tool_calls[](function).function",4440 "type": "object",4441 "required": true,4442 "enum": null,4443 "default": null,4444 "description": "The function that the model called."4445 },4446 {4447 "field": "tool_calls[](custom)",4448 "type": "object",4449 "required": false,4450 "enum": null,4451 "default": null,4452 "description": "A call to a custom tool created by the model."4453 },4454 {4455 "field": "tool_calls[](custom).id",4456 "type": "string",4457 "required": true,4458 "enum": null,4459 "default": null,4460 "description": "The ID of the tool call."4461 },4462 {4463 "field": "tool_calls[](custom).type",4464 "type": "string",4465 "required": true,4466 "enum": [4467 "custom"4468 ],4469 "default": null,4470 "description": "The type of the tool. Always `custom`."4471 },4472 {4473 "field": "tool_calls[](custom).custom",4474 "type": "object",4475 "required": true,4476 "enum": null,4477 "default": null,4478 "description": "The custom tool that the model called."4479 },4480 {4481 "field": "annotations",4482 "type": "array<object>",4483 "required": false,4484 "enum": null,4485 "default": null,4486 "description": "Annotations for the message, when applicable, as when using the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search)."4487 },4488 {4489 "field": "annotations[]",4490 "type": "object",4491 "required": false,4492 "enum": null,4493 "default": null,4494 "description": "A URL citation when using web search."4495 },4496 {4497 "field": "annotations[].type",4498 "type": "string",4499 "required": true,4500 "enum": [4501 "url_citation"4502 ],4503 "default": null,4504 "description": "The type of the URL citation. Always `url_citation`."4505 },4506 {4507 "field": "annotations[].url_citation",4508 "type": "object",4509 "required": true,4510 "enum": null,4511 "default": null,4512 "description": "A URL citation when using web search."4513 },4514 {4515 "field": "annotations[].url_citation.end_index",4516 "type": "integer",4517 "required": true,4518 "enum": null,4519 "default": null,4520 "description": "The index of the last character of the URL citation in the message."4521 },4522 {4523 "field": "annotations[].url_citation.start_index",4524 "type": "integer",4525 "required": true,4526 "enum": null,4527 "default": null,4528 "description": "The index of the first character of the URL citation in the message."4529 },4530 {4531 "field": "annotations[].url_citation.url",4532 "type": "string",4533 "required": true,4534 "enum": null,4535 "default": null,4536 "description": "The URL of the web resource."4537 },4538 {4539 "field": "annotations[].url_citation.title",4540 "type": "string",4541 "required": true,4542 "enum": null,4543 "default": null,4544 "description": "The title of the web resource."4545 },4546 {4547 "field": "role",4548 "type": "string",4549 "required": true,4550 "enum": [4551 "assistant"4552 ],4553 "default": null,4554 "description": "The role of the author of this message."4555 },4556 {4557 "field": "function_call",4558 "type": "object",4559 "required": false,4560 "enum": null,4561 "default": null,4562 "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.",4563 "deprecated": true4564 },4565 {4566 "field": "function_call.arguments",4567 "type": "string",4568 "required": true,4569 "enum": null,4570 "default": null,4571 "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."4572 },4573 {4574 "field": "function_call.name",4575 "type": "string",4576 "required": true,4577 "enum": null,4578 "default": null,4579 "description": "The name of the function to call."4580 },4581 {4582 "field": "audio",4583 "type": "object | null",4584 "required": false,4585 "enum": null,4586 "default": null,4587 "description": "If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](https://developers.openai.com/api/docs/guides/audio)."4588 },4589 {4590 "field": "audio.id",4591 "type": "string",4592 "required": true,4593 "enum": null,4594 "default": null,4595 "description": "Unique identifier for this audio response."4596 },4597 {4598 "field": "audio.expires_at",4599 "type": "integer",4600 "required": true,4601 "enum": null,4602 "default": null,4603 "description": "The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations."4604 },4605 {4606 "field": "audio.data",4607 "type": "string",4608 "required": true,4609 "enum": null,4610 "default": null,4611 "description": "Base64 encoded audio bytes generated by the model, in the format specified in the request."4612 },4613 {4614 "field": "audio.transcript",4615 "type": "string",4616 "required": true,4617 "enum": null,4618 "default": null,4619 "description": "Transcript of the audio generated by the model."4620 }4621 ],4622 "status": [4623 "DOCUMENTED"4624 ],4625 "sources": [4626 {4627 "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",4628 "retrieved_at": "2026-09-18"4629 },4630 {4631 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",4632 "retrieved_at": "2026-09-18"4633 }4634 ]4635 },4636 {4637 "provider": "openai",4638 "object": "CompletionUsage",4639 "type_or_object_value": "usage",4640 "description": "Usage for chat/legacy completions: prompt_tokens, completion_tokens, total_tokens, prompt_tokens_details{cached_tokens, audio_tokens}, completion_tokens_details{reasoning_tokens, audio_tokens, accepted_prediction_tokens, rejected_prediction_tokens}.",4641 "fields": [4642 {4643 "field": "completion_tokens",4644 "type": "integer",4645 "required": true,4646 "enum": null,4647 "default": 0,4648 "description": "Number of tokens in the generated completion."4649 },4650 {4651 "field": "prompt_tokens",4652 "type": "integer",4653 "required": true,4654 "enum": null,4655 "default": 0,4656 "description": "Number of tokens in the prompt."4657 },4658 {4659 "field": "total_tokens",4660 "type": "integer",4661 "required": true,4662 "enum": null,4663 "default": 0,4664 "description": "Total number of tokens used in the request (prompt + completion)."4665 },4666 {4667 "field": "completion_tokens_details",4668 "type": "object",4669 "required": false,4670 "enum": null,4671 "default": null,4672 "description": "Breakdown of tokens used in a completion."4673 },4674 {4675 "field": "completion_tokens_details.accepted_prediction_tokens",4676 "type": "integer",4677 "required": false,4678 "enum": null,4679 "default": 0,4680 "description": "When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion."4681 },4682 {4683 "field": "completion_tokens_details.audio_tokens",4684 "type": "integer",4685 "required": false,4686 "enum": null,4687 "default": 0,4688 "description": "Audio input tokens generated by the model."4689 },4690 {4691 "field": "completion_tokens_details.reasoning_tokens",4692 "type": "integer",4693 "required": false,4694 "enum": null,4695 "default": 0,4696 "description": "Tokens generated by the model for reasoning."4697 },4698 {4699 "field": "completion_tokens_details.text_tokens",4700 "type": "integer",4701 "required": false,4702 "enum": null,4703 "default": null,4704 "description": "Text output tokens generated by the model."4705 },4706 {4707 "field": "completion_tokens_details.rejected_prediction_tokens",4708 "type": "integer",4709 "required": false,4710 "enum": null,4711 "default": 0,4712 "description": "When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits."4713 },4714 {4715 "field": "prompt_tokens_details",4716 "type": "object",4717 "required": false,4718 "enum": null,4719 "default": null,4720 "description": "Breakdown of tokens used in the prompt."4721 },4722 {4723 "field": "prompt_tokens_details.audio_tokens",4724 "type": "integer",4725 "required": false,4726 "enum": null,4727 "default": 0,4728 "description": "Audio input tokens present in the prompt."4729 },4730 {4731 "field": "prompt_tokens_details.cached_tokens",4732 "type": "integer",4733 "required": false,4734 "enum": null,4735 "default": 0,4736 "description": "Cached tokens present in the prompt."4737 },4738 {4739 "field": "prompt_tokens_details.text_tokens",4740 "type": "integer",4741 "required": false,4742 "enum": null,4743 "default": null,4744 "description": "Text input tokens present in the prompt."4745 },4746 {4747 "field": "prompt_tokens_details.image_tokens",4748 "type": "integer",4749 "required": false,4750 "enum": null,4751 "default": null,4752 "description": "Image input tokens present in the prompt."4753 },4754 {4755 "field": "prompt_tokens_details.cache_write_tokens",4756 "type": "integer",4757 "required": false,4758 "enum": null,4759 "default": 0,4760 "description": "The unadjusted number of prompt tokens written to cache."4761 }4762 ],4763 "status": [4764 "DOCUMENTED",4765 "LIVE_VERIFIED"4766 ],4767 "sources": [4768 {4769 "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",4770 "retrieved_at": "2026-09-18"4771 },4772 {4773 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",4774 "retrieved_at": "2026-09-18"4775 }4776 ],4777 "live_example": {4778 "prompt_tokens": 11,4779 "completion_tokens": 1,4780 "total_tokens": 12,4781 "prompt_tokens_details": {4782 "cached_tokens": 0,4783 "audio_tokens": 04784 },4785 "completion_tokens_details": {4786 "reasoning_tokens": 0,4787 "audio_tokens": 0,4788 "accepted_prediction_tokens": 0,4789 "rejected_prediction_tokens": 04790 }4791 }4792 },4793 {4794 "provider": "openai",4795 "object": "Chat completion chunk (CreateChatCompletionStreamResponse)",4796 "type_or_object_value": "object = \"chat.completion.chunk\"",4797 "description": "Streaming chunk; see streaming-events/openai-chat-completions.json.",4798 "fields": [4799 {4800 "field": "id",4801 "type": "string",4802 "required": true,4803 "enum": null,4804 "default": null,4805 "description": "A unique identifier for the chat completion. Each chunk has the same ID."4806 },4807 {4808 "field": "choices",4809 "type": "array<object>",4810 "required": true,4811 "enum": null,4812 "default": null,4813 "description": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the last chunk if you set `stream_options: {\"include_usage\": true}`."4814 },4815 {4816 "field": "choices[]",4817 "type": "object",4818 "required": false,4819 "enum": null,4820 "default": null,4821 "description": ""4822 },4823 {4824 "field": "choices[].delta",4825 "type": "object",4826 "required": true,4827 "enum": null,4828 "default": null,4829 "description": "A chat completion delta generated by streamed model responses."4830 },4831 {4832 "field": "choices[].delta.content",4833 "type": "string | null",4834 "required": false,4835 "enum": null,4836 "default": null,4837 "description": "The contents of the chunk message."4838 },4839 {4840 "field": "choices[].delta.function_call",4841 "type": "object",4842 "required": false,4843 "enum": null,4844 "default": null,4845 "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.",4846 "deprecated": true4847 },4848 {4849 "field": "choices[].delta.tool_calls",4850 "type": "array<object>",4851 "required": false,4852 "enum": null,4853 "default": null,4854 "description": ""4855 },4856 {4857 "field": "choices[].delta.role",4858 "type": "string",4859 "required": false,4860 "enum": [4861 "developer",4862 "system",4863 "user",4864 "assistant",4865 "tool"4866 ],4867 "default": null,4868 "description": "The role of the author of this message."4869 },4870 {4871 "field": "choices[].delta.refusal",4872 "type": "string | null",4873 "required": false,4874 "enum": null,4875 "default": null,4876 "description": "The refusal message generated by the model."4877 },4878 {4879 "field": "choices[].logprobs",4880 "type": "object | null",4881 "required": false,4882 "enum": null,4883 "default": null,4884 "description": "Log probability information for the choice."4885 },4886 {4887 "field": "choices[].logprobs.content",4888 "type": "array<object>",4889 "required": true,4890 "enum": null,4891 "default": null,4892 "description": "A list of message content tokens with log probability information."4893 },4894 {4895 "field": "choices[].logprobs.refusal",4896 "type": "array<object>",4897 "required": true,4898 "enum": null,4899 "default": null,4900 "description": "A list of message refusal tokens with log probability information."4901 },4902 {4903 "field": "choices[].finish_reason",4904 "type": "string | null",4905 "required": true,4906 "enum": [4907 "stop",4908 "length",4909 "tool_calls",4910 "content_filter",4911 "function_call"4912 ],4913 "default": null,4914 "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function."4915 },4916 {4917 "field": "choices[].index",4918 "type": "integer",4919 "required": true,4920 "enum": null,4921 "default": null,4922 "description": "The index of the choice in the list of choices."4923 },4924 {4925 "field": "created",4926 "type": "integer",4927 "required": true,4928 "enum": null,4929 "default": null,4930 "description": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp."4931 },4932 {4933 "field": "model",4934 "type": "string",4935 "required": true,4936 "enum": null,4937 "default": null,4938 "description": "The model to generate the completion."4939 },4940 {4941 "field": "obfuscation",4942 "type": "string",4943 "required": false,4944 "enum": null,4945 "default": null,4946 "description": "An obfuscation string added to normalize the size of streamed chunks as a mitigation to certain side-channel attacks. The field is included by default and omitted when `stream_options.include_obfuscation` is `false`."4947 },4948 {4949 "field": "service_tier",4950 "type": "string | null",4951 "required": false,4952 "enum": [4953 "auto",4954 "default",4955 "flex",4956 "scale",4957 "priority",4958 "fast"4959 ],4960 "default": "auto",4961 "description": "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.ope"4962 },4963 {4964 "field": "system_fingerprint",4965 "type": "string",4966 "required": false,4967 "enum": null,4968 "default": null,4969 "description": "This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.",4970 "deprecated": true4971 },4972 {4973 "field": "object",4974 "type": "string",4975 "required": true,4976 "enum": [4977 "chat.completion.chunk"4978 ],4979 "default": null,4980 "description": "The object type, which is always `chat.completion.chunk`."4981 },4982 {4983 "field": "usage",4984 "type": "object | null",4985 "required": false,4986 "enum": null,4987 "default": null,4988 "description": "An optional field that will only be present when you set `stream_options: {\"include_usage\": true}` in your request. When present, it contains a null value **except for the last chunk** which contains the token usage statistics for the entire request. **NOTE:** If the stream is interrupted or cancelled, you may not receive the final usage chunk which contains the total token usage for the request."4989 },4990 {4991 "field": "usage.completion_tokens",4992 "type": "integer",4993 "required": true,4994 "enum": null,4995 "default": 0,4996 "description": "Number of tokens in the generated completion."4997 },4998 {4999 "field": "usage.prompt_tokens",5000 "type": "integer",5001 "required": true,5002 "enum": null,5003 "default": 0,5004 "description": "Number of tokens in the prompt."5005 },5006 {5007 "field": "usage.total_tokens",5008 "type": "integer",5009 "required": true,5010 "enum": null,5011 "default": 0,5012 "description": "Total number of tokens used in the request (prompt + completion)."5013 },5014 {5015 "field": "usage.completion_tokens_details",5016 "type": "object",5017 "required": false,5018 "enum": null,5019 "default": null,5020 "description": "Breakdown of tokens used in a completion."5021 },5022 {5023 "field": "usage.completion_tokens_details.accepted_prediction_tokens",5024 "type": "integer",5025 "required": false,5026 "enum": null,5027 "default": 0,5028 "description": "When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion."5029 },5030 {5031 "field": "usage.completion_tokens_details.audio_tokens",5032 "type": "integer",5033 "required": false,5034 "enum": null,5035 "default": 0,5036 "description": "Audio input tokens generated by the model."5037 },5038 {5039 "field": "usage.completion_tokens_details.reasoning_tokens",5040 "type": "integer",5041 "required": false,5042 "enum": null,5043 "default": 0,5044 "description": "Tokens generated by the model for reasoning."5045 },5046 {5047 "field": "usage.completion_tokens_details.text_tokens",5048 "type": "integer",5049 "required": false,5050 "enum": null,5051 "default": null,5052 "description": "Text output tokens generated by the model."5053 },5054 {5055 "field": "usage.completion_tokens_details.rejected_prediction_tokens",5056 "type": "integer",5057 "required": false,5058 "enum": null,5059 "default": 0,5060 "description": "When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits."5061 },5062 {5063 "field": "usage.prompt_tokens_details",5064 "type": "object",5065 "required": false,5066 "enum": null,5067 "default": null,5068 "description": "Breakdown of tokens used in the prompt."5069 },5070 {5071 "field": "usage.prompt_tokens_details.audio_tokens",5072 "type": "integer",5073 "required": false,5074 "enum": null,5075 "default": 0,5076 "description": "Audio input tokens present in the prompt."5077 },5078 {5079 "field": "usage.prompt_tokens_details.cached_tokens",5080 "type": "integer",5081 "required": false,5082 "enum": null,5083 "default": 0,5084 "description": "Cached tokens present in the prompt."5085 },5086 {5087 "field": "usage.prompt_tokens_details.text_tokens",5088 "type": "integer",5089 "required": false,5090 "enum": null,5091 "default": null,5092 "description": "Text input tokens present in the prompt."5093 },5094 {5095 "field": "usage.prompt_tokens_details.image_tokens",5096 "type": "integer",5097 "required": false,5098 "enum": null,5099 "default": null,5100 "description": "Image input tokens present in the prompt."5101 },5102 {5103 "field": "usage.prompt_tokens_details.cache_write_tokens",5104 "type": "integer",5105 "required": false,5106 "enum": null,5107 "default": 0,5108 "description": "The unadjusted number of prompt tokens written to cache."5109 },5110 {5111 "field": "moderation",5112 "type": "object | null",5113 "required": false,5114 "enum": null,5115 "default": null,5116 "description": "Moderation results for the request input and generated output. Present on the moderation chunk when moderated completions are requested."5117 },5118 {5119 "field": "moderation.input",5120 "type": "object<moderation_results> | object<error>",5121 "required": true,5122 "enum": null,5123 "default": null,5124 "description": "Moderation for the request input."5125 },5126 {5127 "field": "moderation.input(moderation_results)",5128 "type": "object",5129 "required": true,5130 "enum": null,5131 "default": null,5132 "description": "Successful moderation results for the request input or generated output."5133 },5134 {5135 "field": "moderation.input(error)",5136 "type": "object",5137 "required": true,5138 "enum": null,5139 "default": null,5140 "description": "An error produced while attempting moderation."5141 },5142 {5143 "field": "moderation.output",5144 "type": "object<moderation_results> | object<error>",5145 "required": true,5146 "enum": null,5147 "default": null,5148 "description": "Moderation for the generated output."5149 },5150 {5151 "field": "moderation.output(moderation_results)",5152 "type": "object",5153 "required": true,5154 "enum": null,5155 "default": null,5156 "description": "Successful moderation results for the request input or generated output."5157 },5158 {5159 "field": "moderation.output(error)",5160 "type": "object",5161 "required": true,5162 "enum": null,5163 "default": null,5164 "description": "An error produced while attempting moderation."5165 }5166 ],5167 "status": [5168 "DOCUMENTED"5169 ],5170 "sources": [5171 {5172 "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events",5173 "retrieved_at": "2026-09-18"5174 },5175 {5176 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",5177 "retrieved_at": "2026-09-18"5178 }5179 ]5180 },5181 {5182 "provider": "openai",5183 "object": "ChatCompletionList / ChatCompletionMessageList / ChatCompletionDeleted",5184 "type_or_object_value": "object = \"list\" | \"chat.completion.deleted\"",5185 "description": "List wrappers for stored chat completions and their messages; delete confirmation.",5186 "fields": [5187 {5188 "field": "object",5189 "type": "string",5190 "required": true,5191 "enum": [5192 "list"5193 ],5194 "default": "list",5195 "description": "The type of this object. It is always set to \"list\"."5196 },5197 {5198 "field": "data",5199 "type": "array<object>",5200 "required": true,5201 "enum": null,5202 "default": null,5203 "description": "An array of chat completion objects."5204 },5205 {5206 "field": "data[]",5207 "type": "object",5208 "required": false,5209 "enum": null,5210 "default": null,5211 "description": "Represents a chat completion response returned by model, based on the provided input."5212 },5213 {5214 "field": "first_id",5215 "type": "string",5216 "required": true,5217 "enum": null,5218 "default": null,5219 "description": "The identifier of the first chat completion in the data array."5220 },5221 {5222 "field": "last_id",5223 "type": "string",5224 "required": true,5225 "enum": null,5226 "default": null,5227 "description": "The identifier of the last chat completion in the data array."5228 },5229 {5230 "field": "has_more",5231 "type": "boolean",5232 "required": true,5233 "enum": null,5234 "default": null,5235 "description": "Indicates whether there are more Chat Completions available."5236 },5237 {5238 "field": "messages.data[].content",5239 "type": "string | null",5240 "required": true,5241 "enum": null,5242 "default": null,5243 "description": "The contents of the message."5244 },5245 {5246 "field": "messages.data[].refusal",5247 "type": "string | null",5248 "required": true,5249 "enum": null,5250 "default": null,5251 "description": "The refusal message generated by the model."5252 },5253 {5254 "field": "messages.data[].tool_calls",5255 "type": "array<object<function> | object<custom>>",5256 "required": false,5257 "enum": null,5258 "default": null,5259 "description": "The tool calls generated by the model, such as function calls."5260 },5261 {5262 "field": "messages.data[].tool_calls[]",5263 "type": "object<function> | object<custom>",5264 "required": false,5265 "enum": null,5266 "default": null,5267 "description": ""5268 },5269 {5270 "field": "messages.data[].annotations",5271 "type": "array<object>",5272 "required": false,5273 "enum": null,5274 "default": null,5275 "description": "Annotations for the message, when applicable, as when using the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search)."5276 },5277 {5278 "field": "messages.data[].annotations[]",5279 "type": "object",5280 "required": false,5281 "enum": null,5282 "default": null,5283 "description": "A URL citation when using web search."5284 },5285 {5286 "field": "messages.data[].role",5287 "type": "string",5288 "required": true,5289 "enum": [5290 "assistant"5291 ],5292 "default": null,5293 "description": "The role of the author of this message."5294 },5295 {5296 "field": "messages.data[].function_call",5297 "type": "object",5298 "required": false,5299 "enum": null,5300 "default": null,5301 "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.",5302 "deprecated": true5303 },5304 {5305 "field": "messages.data[].audio",5306 "type": "object | null",5307 "required": false,5308 "enum": null,5309 "default": null,5310 "description": "If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](https://developers.openai.com/api/docs/guides/audio)."5311 },5312 {5313 "field": "messages.data[].id",5314 "type": "string",5315 "required": true,5316 "enum": null,5317 "default": null,5318 "description": "The identifier of the chat message."5319 },5320 {5321 "field": "messages.data[].content_parts",5322 "type": "array<object<text> | object<image_url>>",5323 "required": false,5324 "enum": null,5325 "default": null,5326 "description": "If a content parts array was provided, this is an array of `text` and `image_url` parts. Otherwise, null."5327 },5328 {5329 "field": "messages.data[].content_parts[]",5330 "type": "object<text> | object<image_url>",5331 "required": false,5332 "enum": null,5333 "default": null,5334 "description": ""5335 },5336 {5337 "field": "object",5338 "type": "string",5339 "required": true,5340 "enum": [5341 "chat.completion.deleted"5342 ],5343 "default": null,5344 "description": "The type of object being deleted."5345 },5346 {5347 "field": "id",5348 "type": "string",5349 "required": true,5350 "enum": null,5351 "default": null,5352 "description": "The ID of the chat completion that was deleted."5353 },5354 {5355 "field": "deleted",5356 "type": "boolean",5357 "required": true,5358 "enum": null,5359 "default": null,5360 "description": "Whether the chat completion was deleted."5361 }5362 ],5363 "status": [5364 "DOCUMENTED",5365 "LIVE_VERIFIED"5366 ],5367 "sources": [5368 {5369 "url": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/list",5370 "retrieved_at": "2026-09-18"5371 },5372 {5373 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",5374 "retrieved_at": "2026-09-18"5375 }5376 ],5377 "live_example": {5378 "messages": {5379 "object": "list",5380 "data": [5381 {5382 "id": "chatcmpl-EPeQIxYbGWnmCZK1AVyIkziHT8E7j-0",5383 "role": "user",5384 "content": "Reply with OK.",5385 "content_parts": null,5386 "name": null5387 }5388 ],5389 "first_id": "chatcmpl-EPeQIxYbGWnmCZK1AVyIkziHT8E7j-0",5390 "last_id": "chatcmpl-EPeQIxYbGWnmCZK1AVyIkziHT8E7j-0",5391 "has_more": false5392 },5393 "deleted": {5394 "object": "chat.completion.deleted",5395 "id": "chatcmpl-EPeQIxYbGWnmCZK1AVyIkziHT8E7j",5396 "deleted": true5397 }5398 }5399 },5400 {5401 "provider": "openai",5402 "object": "Text completion (CreateCompletionResponse)",5403 "type_or_object_value": "object = \"text_completion\"",5404 "description": "Legacy completion object: choices[].{text, index, logprobs{tokens, token_logprobs, top_logprobs, text_offset}, finish_reason}, usage.",5405 "fields": [5406 {5407 "field": "id",5408 "type": "string",5409 "required": true,5410 "enum": null,5411 "default": null,5412 "description": "A unique identifier for the completion."5413 },5414 {5415 "field": "choices",5416 "type": "array<object>",5417 "required": true,5418 "enum": null,5419 "default": null,5420 "description": "The list of completion choices the model generated for the input prompt."5421 },5422 {5423 "field": "choices[]",5424 "type": "object",5425 "required": false,5426 "enum": null,5427 "default": null,5428 "description": ""5429 },5430 {5431 "field": "choices[].finish_reason",5432 "type": "string",5433 "required": true,5434 "enum": [5435 "stop",5436 "length",5437 "content_filter"5438 ],5439 "default": null,5440 "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, or `content_filter` if content was omitted due to a flag from our content filters."5441 },5442 {5443 "field": "choices[].index",5444 "type": "integer",5445 "required": true,5446 "enum": null,5447 "default": null,5448 "description": ""5449 },5450 {5451 "field": "choices[].logprobs",5452 "type": "object | null",5453 "required": true,5454 "enum": null,5455 "default": null,5456 "description": ""5457 },5458 {5459 "field": "choices[].logprobs.text_offset",5460 "type": "array<integer>",5461 "required": false,5462 "enum": null,5463 "default": null,5464 "description": ""5465 },5466 {5467 "field": "choices[].logprobs.token_logprobs",5468 "type": "array<number>",5469 "required": false,5470 "enum": null,5471 "default": null,5472 "description": ""5473 },5474 {5475 "field": "choices[].logprobs.tokens",5476 "type": "array<string>",5477 "required": false,5478 "enum": null,5479 "default": null,5480 "description": ""5481 },5482 {5483 "field": "choices[].logprobs.top_logprobs",5484 "type": "array<map<string,number>>",5485 "required": false,5486 "enum": null,5487 "default": null,5488 "description": ""5489 },5490 {5491 "field": "choices[].text",5492 "type": "string",5493 "required": true,5494 "enum": null,5495 "default": null,5496 "description": ""5497 },5498 {5499 "field": "created",5500 "type": "integer",5501 "required": true,5502 "enum": null,5503 "default": null,5504 "description": "The Unix timestamp (in seconds) of when the completion was created."5505 },5506 {5507 "field": "model",5508 "type": "string",5509 "required": true,5510 "enum": null,5511 "default": null,5512 "description": "The model used for completion."5513 },5514 {5515 "field": "system_fingerprint",5516 "type": "string",5517 "required": false,5518 "enum": null,5519 "default": null,5520 "description": "This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism."5521 },5522 {5523 "field": "object",5524 "type": "string",5525 "required": true,5526 "enum": [5527 "text_completion"5528 ],5529 "default": null,5530 "description": "The object type, which is always \"text_completion\""5531 },5532 {5533 "field": "usage",5534 "type": "object",5535 "required": false,5536 "enum": null,5537 "default": null,5538 "description": "Usage statistics for the completion request."5539 },5540 {5541 "field": "usage.completion_tokens",5542 "type": "integer",5543 "required": true,5544 "enum": null,5545 "default": 0,5546 "description": "Number of tokens in the generated completion."5547 },5548 {5549 "field": "usage.prompt_tokens",5550 "type": "integer",5551 "required": true,5552 "enum": null,5553 "default": 0,5554 "description": "Number of tokens in the prompt."5555 },5556 {5557 "field": "usage.total_tokens",5558 "type": "integer",5559 "required": true,5560 "enum": null,5561 "default": 0,5562 "description": "Total number of tokens used in the request (prompt + completion)."5563 },5564 {5565 "field": "usage.completion_tokens_details",5566 "type": "object",5567 "required": false,5568 "enum": null,5569 "default": null,5570 "description": "Breakdown of tokens used in a completion."5571 },5572 {5573 "field": "usage.completion_tokens_details.accepted_prediction_tokens",5574 "type": "integer",5575 "required": false,5576 "enum": null,5577 "default": 0,5578 "description": "When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion."5579 },5580 {5581 "field": "usage.completion_tokens_details.audio_tokens",5582 "type": "integer",5583 "required": false,5584 "enum": null,5585 "default": 0,5586 "description": "Audio input tokens generated by the model."5587 },5588 {5589 "field": "usage.completion_tokens_details.reasoning_tokens",5590 "type": "integer",5591 "required": false,5592 "enum": null,5593 "default": 0,5594 "description": "Tokens generated by the model for reasoning."5595 },5596 {5597 "field": "usage.completion_tokens_details.text_tokens",5598 "type": "integer",5599 "required": false,5600 "enum": null,5601 "default": null,5602 "description": "Text output tokens generated by the model."5603 },5604 {5605 "field": "usage.completion_tokens_details.rejected_prediction_tokens",5606 "type": "integer",5607 "required": false,5608 "enum": null,5609 "default": 0,5610 "description": "When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits."5611 },5612 {5613 "field": "usage.prompt_tokens_details",5614 "type": "object",5615 "required": false,5616 "enum": null,5617 "default": null,5618 "description": "Breakdown of tokens used in the prompt."5619 },5620 {5621 "field": "usage.prompt_tokens_details.audio_tokens",5622 "type": "integer",5623 "required": false,5624 "enum": null,5625 "default": 0,5626 "description": "Audio input tokens present in the prompt."5627 },5628 {5629 "field": "usage.prompt_tokens_details.cached_tokens",5630 "type": "integer",5631 "required": false,5632 "enum": null,5633 "default": 0,5634 "description": "Cached tokens present in the prompt."5635 },5636 {5637 "field": "usage.prompt_tokens_details.text_tokens",5638 "type": "integer",5639 "required": false,5640 "enum": null,5641 "default": null,5642 "description": "Text input tokens present in the prompt."5643 },5644 {5645 "field": "usage.prompt_tokens_details.image_tokens",5646 "type": "integer",5647 "required": false,5648 "enum": null,5649 "default": null,5650 "description": "Image input tokens present in the prompt."5651 },5652 {5653 "field": "usage.prompt_tokens_details.cache_write_tokens",5654 "type": "integer",5655 "required": false,5656 "enum": null,5657 "default": 0,5658 "description": "The unadjusted number of prompt tokens written to cache."5659 }5660 ],5661 "status": [5662 "DOCUMENTED",5663 "LEGACY",5664 "LIVE_VERIFIED"5665 ],5666 "sources": [5667 {5668 "url": "https://developers.openai.com/api/reference/resources/completions/methods/create",5669 "retrieved_at": "2026-09-18"5670 },5671 {5672 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",5673 "retrieved_at": "2026-09-18"5674 }5675 ],5676 "live_example": {5677 "id": "cmpl-EPeQRoNLGecGLCec2TobwS3m5VPKn",5678 "object": "text_completion",5679 "created": 1789782303,5680 "model": "gpt-3.5-turbo-instruct:20230824-v2",5681 "choices": [5682 {5683 "text": "\n\nOK.",5684 "index": 0,5685 "logprobs": null,5686 "finish_reason": "stop"5687 }5688 ],5689 "usage": {5690 "prompt_tokens": 3,5691 "completion_tokens": 3,5692 "total_tokens": 65693 }5694 }5695 },5696 {5697 "provider": "openai",5698 "object": "Logprobs (ResponseLogProb / ChatCompletionTokenLogprob)",5699 "type_or_object_value": "logprobs[]",5700 "description": "Per-token log probabilities: token, logprob, bytes[], top_logprobs[].",5701 "fields": [5702 {5703 "field": "token",5704 "type": "string",5705 "required": true,5706 "enum": null,5707 "default": null,5708 "description": "A possible text token."5709 },5710 {5711 "field": "logprob",5712 "type": "number",5713 "required": true,5714 "enum": null,5715 "default": null,5716 "description": "The log probability of this token."5717 },5718 {5719 "field": "top_logprobs",5720 "type": "array<object>",5721 "required": false,5722 "enum": null,5723 "default": null,5724 "description": "The log probabilities of up to 20 of the most likely tokens."5725 },5726 {5727 "field": "top_logprobs[]",5728 "type": "object",5729 "required": false,5730 "enum": null,5731 "default": null,5732 "description": ""5733 },5734 {5735 "field": "top_logprobs[].token",5736 "type": "string",5737 "required": false,5738 "enum": null,5739 "default": null,5740 "description": "A possible text token."5741 },5742 {5743 "field": "top_logprobs[].logprob",5744 "type": "number",5745 "required": false,5746 "enum": null,5747 "default": null,5748 "description": "The log probability of this token."5749 },5750 {5751 "field": "chat: token",5752 "type": "string",5753 "required": true,5754 "enum": null,5755 "default": null,5756 "description": "The token."5757 },5758 {5759 "field": "chat: logprob",5760 "type": "number",5761 "required": true,5762 "enum": null,5763 "default": null,5764 "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely."5765 },5766 {5767 "field": "chat: bytes",5768 "type": "array<integer>",5769 "required": true,5770 "enum": null,5771 "default": null,5772 "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."5773 },5774 {5775 "field": "chat: bytes[]",5776 "type": "integer",5777 "required": false,5778 "enum": null,5779 "default": null,5780 "description": ""5781 },5782 {5783 "field": "chat: top_logprobs",5784 "type": "array<object>",5785 "required": true,5786 "enum": null,5787 "default": null,5788 "description": "List of the most likely tokens and their log probability, at this token position. The number of entries may be fewer than the requested `top_logprobs`."5789 },5790 {5791 "field": "chat: top_logprobs[]",5792 "type": "object",5793 "required": false,5794 "enum": null,5795 "default": null,5796 "description": ""5797 },5798 {5799 "field": "chat: top_logprobs[].token",5800 "type": "string",5801 "required": true,5802 "enum": null,5803 "default": null,5804 "description": "The token."5805 },5806 {5807 "field": "chat: top_logprobs[].logprob",5808 "type": "number",5809 "required": true,5810 "enum": null,5811 "default": null,5812 "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely."5813 },5814 {5815 "field": "chat: top_logprobs[].bytes",5816 "type": "array<integer>",5817 "required": true,5818 "enum": null,5819 "default": null,5820 "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token."5821 }5822 ],5823 "status": [5824 "DOCUMENTED",5825 "LIVE_VERIFIED"5826 ],5827 "sources": [5828 {5829 "url": "https://developers.openai.com/api/reference/resources/responses/methods/create",5830 "retrieved_at": "2026-09-18"5831 },5832 {5833 "url": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",5834 "retrieved_at": "2026-09-18"5835 }5836 ],5837 "live_example": {5838 "responses": {5839 "bytes": [5840 79,5841 755842 ],5843 "logprob": -9e-06,5844 "token": "OK",5845 "top_logprobs": [5846 {5847 "bytes": [5848 79,5849 755850 ],5851 "logprob": -8e-06,5852 "token": "OK"5853 }5854 ]5855 }5856 }5857 }5858 ]5859}