> ## Documentation Index > Fetch the complete documentation index at: https://docs.mka1.com/llms.txt > Use this file to discover all available pages before exploring further. # List conversation items > List all items for a conversation with the given ID. ## OpenAPI ````yaml https://apigw.mka1.com/speakeasy.json get /api/v1/llm/conversations/{conversation_id}/items openapi: 3.1.1 info: title: MKA1 API version: 1.1.0 description: >- The MKA1 API is a RESTful API that provides access to the MKA1 platform. Learn how to get started with the API and the TypeScript SDK [here](https://mka1.apidocumentation.com/guides/getting-started). license: name: Proprietary servers: - url: https://apigw.mka1.com description: MKA1 API Gateway - url: / description: Relative server URL (configurable via SDK constructor) security: [] tags: - name: Resource Authorization description: >- Manage permissions for LLM resources. Create resources, grant/revoke permissions, and delete resources. Only resource owners can grant, revoke, or delete permissions. x-displayName: Resource Authorization - name: Embeddings description: >- Text embedding API endpoints for generating vector representations of text. Create semantic embeddings for search, clustering, and similarity matching using various embedding models. x-displayName: Embeddings - name: Feedback description: >- User feedback API for rating and commenting on chat completions. Collect thumbs up/down ratings and detailed feedback to improve model responses and track user satisfaction. x-displayName: Feedback - name: Images description: >- Image generation API endpoints for creating images from text descriptions. Generate images with control over size, quality, and style. x-displayName: Images - name: MCP Vault description: >- MCP vault API for storing user-owned MCP server configurations and encrypted credentials. Agents reference vault IDs so secrets are resolved only at tool execution time. x-displayName: MCP Vault - name: Speech description: >- Speech API endpoints for audio processing. Convert text to natural-sounding speech (TTS) or transcribe speech to text (STT) in different languages. x-displayName: Speech - name: Usage description: >- Usage tracking and analytics API for monitoring token consumption, request counts, and cost analysis. View detailed statistics per user, model, and time period. x-displayName: Usage - name: Extract description: >- Structured data extraction API for extracting information from files. Define JSON schemas to extract structured data from images, PDFs, and documents. Supports reusable schema templates. x-displayName: Extract - name: Text Classification description: >- Text classification API for categorizing text into predefined labels. Use AI models to classify text content for sentiment analysis, topic categorization, and content moderation. x-displayName: Text Classification - name: Responses description: >- Agent-powered responses API for creating AI agents with autonomous tool usage. Build conversational assistants that can use web search, file operations, image generation, code execution, computer use simulation, and MCP integrations. Supports background processing, streaming, and real-time status tracking. x-displayName: Responses - name: Files description: >- File management API for uploading, storing, and managing files with automatic expiration and S3 integration. Upload files that can be used with Assistants, Vector Stores, and other features. Files are stored in S3 with metadata tracked in PostgreSQL. Supports automatic cleanup of expired files. x-displayName: Files - name: Vector Stores description: >- Vector store API for storing and searching documents using embeddings. Create vector stores, upload files with automatic chunking and embedding generation, and perform semantic search. Files are processed asynchronously using Temporal workflows for durability. Supports automatic cleanup of expired stores and LanceDB for efficient vector storage. x-displayName: Vector Stores - name: Conversations description: >- Conversation management API for storing and retrieving conversation state across Response API calls. Create conversations, add items (user messages, assistant messages, system messages), and maintain conversation history. Supports metadata tracking and multi-turn dialogue state management. x-displayName: Conversations - name: Guardrails description: >- AI safety guardrails API for configuring content moderation and security policies. Set up ban word lists, prompt injection detection, and system prompt leakage prevention. Guardrails apply to all requests from an account and can be tested before deployment. x-displayName: Guardrails - name: Models description: >- Model listing API for discovering available models. Returns model IDs, ownership, and metadata for all registered models in the gateway. x-displayName: Models - name: Skills description: >- Skills API for managing versioned bundles of instructions and files following the Agent Skills standard. Create, version, and download reusable skill packages that include SKILL.md manifests for agent environments. x-displayName: Skills - name: Chat Completions description: >- **Deprecated: Use the Responses API (`/api/v1/llm/responses`) instead.** Chat completion endpoints with support for streaming, tool calls, and multiple providers. x-deprecated: true x-displayName: Chat Completions - name: Batches x-displayName: Batches - name: Evals x-displayName: Evals - name: Fine-Tuning x-displayName: Fine-Tuning - name: Memory Stores x-displayName: Memory Stores - name: Prompts x-displayName: Prompts - name: API Key x-displayName: API Key - name: Organization x-displayName: Organization - name: Cluster Admin x-displayName: Cluster Admin - name: Sessions description: Create, inspect, access, and terminate sandbox sessions. x-displayName: Sessions - name: Browser description: >- Connect to browser sessions through the gateway port proxy. Browser sessions expose a Chrome DevTools Protocol endpoint on port 9222. x-displayName: Browser - name: Execution description: Run shell commands and code inside an existing sandbox session. x-displayName: Execution - name: Workspace description: >- Inspect the workspace manifest, transfer files or archives, and download generated artifacts. x-displayName: Workspace - name: Sandbox Usage description: >- Aggregate sandbox usage statistics across sessions, execution, and workspace operations. x-displayName: Sandbox Usage - name: Sandbox Pricing description: >- Cluster-admin management of the sandbox compute rate card used for budgeted spend. x-displayName: Sandbox Pricing - name: Agents description: Create and manage reusable agent definitions. x-displayName: Agents - name: Agent Versions description: Inspect an agent's configuration history and roll back to a prior version. x-displayName: Agent Versions - name: Agent Runs description: Execute saved agents and inspect persisted run results. x-displayName: Agent Runs - name: Agent Connectors description: >- Connect saved agents to external messaging channels such as Telegram, including text, photo, and supported document exchange. x-displayName: Agent Connectors - name: Agent Schedules description: Create and manage scheduled or recurring saved agent runs. x-displayName: Agent Schedules - name: schema-4_other x-displayName: other - name: Budgets x-displayName: Budgets - name: Settings x-displayName: Settings - name: Deployments description: Long-lived inference servers. x-displayName: Deployments - name: Fine-Tune Jobs description: Submit, monitor, and cancel fine-tune jobs. x-displayName: Fine-Tune Jobs - name: Container Images description: Custom container images for deployments and jobs. x-displayName: Container Images - name: Serving Models description: Models registered for deployment and fine-tuning. x-displayName: Serving Models - name: Volumes description: Persistent storage for weights and checkpoints. x-displayName: Volumes - name: Secrets description: Credentials injected into your workloads. x-displayName: Secrets - name: Accelerators description: Available accelerator types (GPU, NPU, TPU). x-displayName: Accelerators paths: /api/v1/llm/conversations/{conversation_id}/items: get: tags: - Conversations summary: List conversation items description: List all items for a conversation with the given ID. operationId: conversations.items.list parameters: - name: conversation_id in: path required: true schema: type: string description: The ID of the conversation example: conv_abc123 - name: after in: query schema: type: string description: Item ID to list items after (pagination cursor) examples: - item_abc123 allowEmptyValue: true example: item_abc123 - name: include in: query schema: type: array items: type: string description: 'Additional fields to include (TODO: not implemented yet)' examples: - - content - metadata allowEmptyValue: true example: - content - metadata - name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 20 description: Max number of items to return (1-100, default 20) examples: - 50 allowEmptyValue: true example: 50 - name: order in: query schema: enum: - asc - desc type: string default: asc description: The order to return the input items in. Default is `asc`. examples: - desc allowEmptyValue: true example: desc - name: X-On-Behalf-Of in: header required: false schema: type: string description: Optional external end-user identifier forwarded by the API gateway. responses: '200': description: OK content: application/json: schema: type: object properties: object: const: list data: type: array items: anyOf: - allOf: - $ref: '#/components/schemas/InputMessage' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: >- The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: >- Metadata from the response that created this item, if any. required: - id - $ref: '#/components/schemas/OutputMessageWithId' - $ref: '#/components/schemas/OutputAudioItemWithId' - $ref: '#/components/schemas/FileSearchToolCallWithId' - $ref: '#/components/schemas/ComputerToolCallWithId' - $ref: '#/components/schemas/ComputerToolCallOutputWithId' - $ref: '#/components/schemas/WebSearchToolCallWithId' - $ref: '#/components/schemas/FunctionToolCallWithId' - $ref: '#/components/schemas/FunctionToolCallOutputWithId' - $ref: '#/components/schemas/ReasoningWithId' - $ref: '#/components/schemas/ImageGenerationCallWithId' - $ref: '#/components/schemas/CodeInterpreterToolCallWithId' - $ref: '#/components/schemas/LocalShellCallWithId' - $ref: '#/components/schemas/LocalShellCallOutputWithId' - $ref: '#/components/schemas/ShellCallWithId' - $ref: '#/components/schemas/ShellCallOutputWithId' - $ref: '#/components/schemas/MCPListToolsWithId' - $ref: '#/components/schemas/MCPApprovalRequestWithId' - $ref: '#/components/schemas/MCPApprovalResponseWithId' - $ref: '#/components/schemas/MCPToolCallWithId' - $ref: '#/components/schemas/CustomToolCallWithId' - $ref: '#/components/schemas/CustomToolCallOutputWithId' - $ref: '#/components/schemas/ItemReferenceWithId' - $ref: '#/components/schemas/ResponseCompactionItemWithId' description: A list of conversation items. has_more: type: boolean description: Whether there are more items last_id: type: string description: ID of the last item in the current page required: - data - has_more - last_id examples: - object: list data: - id: item_abc123 type: message role: user content: Hello, how are you? has_more: false last_id: item_abc123 example: object: list data: - id: item_abc123 response_id: resp_abc123 type: message role: user content: What is the weather today? has_more: false last_id: item_abc123 security: - bearerAuth: [] x-codeSamples: - lang: python label: Python (SDK) source: |- from meetkai_mka1 import SDK with SDK( bearer_auth="", ) as sdk: res = sdk.llm.conversations.list_items(conversation_id="conv_abc123", after="item_abc123", include=[ "content", "metadata", ], limit=50, order="desc") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SDK } from "@meetkai/mka1"; const sdk = new SDK({ bearerAuth: "", }); async function run() { const result = await sdk.llm.conversations.listItems({ conversationId: "conv_abc123", after: "item_abc123", include: [ "content", "metadata", ], limit: 50, order: "desc", }); console.log(result); } run(); - lang: csharp label: CSharp (SDK) source: >- using MeetKai.MKA1; using MeetKai.MKA1.Types.Components; using MeetKai.MKA1.Types.Requests; using System.Collections.Generic; var sdk = new SDK(bearerAuth: ""); ConversationsItemsListRequest req = new ConversationsItemsListRequest() { ConversationId = "conv_abc123", After = "item_abc123", Include = new List() { "content", "metadata", }, Limit = 50, Order = ConversationsItemsListOrder.Desc, }; var res = await sdk.Llm.Conversations.ListItemsAsync(req); // handle response components: schemas: InputMessage: type: object properties: type: const: message description: The item type identifier. Always 'message' for message items. role: enum: - user - assistant - system - developer type: string description: >- The role of the message sender (user, assistant, system, or developer). content: anyOf: - type: string - $ref: '#/components/schemas/InputMessageContent' description: >- The message content. Can be a simple text string or an array of multimodal content items (text, images, files, audio). status: $ref: '#/components/schemas/Status' description: >- The processing status of this message. Optional - indicates if the message is in_progress, completed, or incomplete. id: type: string default: msg_aa87e2b1112a455b8deabed784372198 required: - role - content title: Input message item description: >- Input message item: A message with role and content. Use this for user, assistant, system, or developer turns in structured inputs. OutputMessageWithId: allOf: - $ref: '#/components/schemas/OutputMessage' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id OutputAudioItemWithId: allOf: - $ref: '#/components/schemas/OutputAudioItem' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id FileSearchToolCallWithId: allOf: - $ref: '#/components/schemas/FileSearchToolCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id ComputerToolCallWithId: allOf: - $ref: '#/components/schemas/ComputerToolCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id ComputerToolCallOutputWithId: allOf: - $ref: '#/components/schemas/ComputerToolCallOutput' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id WebSearchToolCallWithId: allOf: - $ref: '#/components/schemas/WebSearchToolCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id FunctionToolCallWithId: allOf: - $ref: '#/components/schemas/FunctionToolCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id FunctionToolCallOutputWithId: allOf: - $ref: '#/components/schemas/FunctionToolCallOutput' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id ReasoningWithId: allOf: - $ref: '#/components/schemas/Reasoning' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id ImageGenerationCallWithId: allOf: - $ref: '#/components/schemas/ImageGenerationCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id CodeInterpreterToolCallWithId: allOf: - $ref: '#/components/schemas/CodeInterpreterToolCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id LocalShellCallWithId: allOf: - $ref: '#/components/schemas/LocalShellCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id LocalShellCallOutputWithId: allOf: - $ref: '#/components/schemas/LocalShellCallOutput' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id ShellCallWithId: allOf: - $ref: '#/components/schemas/ShellCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id ShellCallOutputWithId: allOf: - $ref: '#/components/schemas/ShellCallOutput' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id MCPListToolsWithId: allOf: - $ref: '#/components/schemas/MCPListTools' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id MCPApprovalRequestWithId: allOf: - $ref: '#/components/schemas/MCPApprovalRequest' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id MCPApprovalResponseWithId: allOf: - $ref: '#/components/schemas/MCPApprovalResponse' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id MCPToolCallWithId: allOf: - $ref: '#/components/schemas/MCPToolCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id CustomToolCallWithId: allOf: - $ref: '#/components/schemas/CustomToolCall' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id CustomToolCallOutputWithId: allOf: - $ref: '#/components/schemas/CustomToolCallOutput' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id ItemReferenceWithId: allOf: - $ref: '#/components/schemas/ItemReference' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id ResponseCompactionItemWithId: allOf: - $ref: '#/components/schemas/ResponseCompactionItem' - type: object properties: id: type: string description: The unique ID of the message. response_id: anyOf: - type: string - type: 'null' description: The ID of the response that created this item, if any. metadata: anyOf: - type: object propertyNames: type: string additionalProperties: type: string - type: 'null' description: Metadata from the response that created this item, if any. required: - id InputMessageContent: type: array items: anyOf: - type: string - $ref: '#/components/schemas/InputText' - $ref: '#/components/schemas/InputImage' - $ref: '#/components/schemas/InputFile' - $ref: '#/components/schemas/InputAudio' - $ref: '#/components/schemas/OutputText' - $ref: '#/components/schemas/Refusal' description: >- Array of content items for a multimodal message. Can contain text strings, text objects, images, files, audio, or output text blocks from previous assistant turns. Status: enum: - in_progress - completed - incomplete type: string description: >- The processing status of an individual item. 'in_progress' means currently processing, 'completed' means finished successfully, 'incomplete' means processing stopped before completion. OutputMessage: type: object properties: type: const: message description: The item type identifier for message outputs. id: type: string description: The unique identifier for this output message. role: const: assistant description: >- The role of the message sender. Always 'assistant' for model-generated messages. content: type: array items: anyOf: - $ref: '#/components/schemas/OutputText' - $ref: '#/components/schemas/Refusal' description: >- Array of content items in the assistant's response. Can contain text outputs or refusal messages. status: enum: - in_progress - completed - incomplete type: string description: >- The processing status of this message (in_progress, completed, or incomplete). phase: enum: - commentary - final_answer type: string description: >- Labels an assistant message as intermediate commentary or the final answer. required: - type - id - role - content - status title: Output message item description: >- Output message item: An assistant message containing generated text content or refusal content. OutputAudioItem: type: object properties: type: const: output_audio description: The content type identifier for audio output. data: type: string description: Base64-encoded audio data. transcript: type: string description: The text transcript that was synthesized into audio. id: type: string description: The unique identifier for this output audio item. status: enum: - in_progress - completed - incomplete type: string description: The processing status of this audio item. required: - type - data - transcript - id - status title: Output audio item description: >- Output audio item: Audio content synthesized from the model's text response via TTS. FileSearchToolCall: type: object properties: type: const: file_search_call id: type: string queries: type: array items: type: string status: enum: - in_progress - searching - completed - incomplete - failed type: string results: type: array items: $ref: '#/components/schemas/FileSearchResult' required: - type - id - queries - status title: File search call item description: >- File search call item: A tool-call record for semantic file search, including query terms, status, and optional results. ComputerToolCall: type: object properties: type: const: computer_call id: type: string call_id: type: string action: $ref: '#/components/schemas/ComputerAction' pending_safety_checks: type: array items: $ref: '#/components/schemas/PendingSafetyCheck' status: $ref: '#/components/schemas/Status' required: - type - id - call_id - action - pending_safety_checks - status title: Computer call item description: >- Computer call item: A computer-use tool-call step with the selected UI action and safety-check state. ComputerToolCallOutput: type: object properties: type: const: computer_call_output call_id: type: string output: $ref: '#/components/schemas/ComputerScreenshot' acknowledged_safety_checks: type: array items: $ref: '#/components/schemas/AcknowledgedSafetyCheck' id: type: string status: $ref: '#/components/schemas/Status' required: - type - call_id - output title: Computer call output item description: >- Computer call output item: Output emitted by a computer-use tool call, typically including screenshot data. WebSearchToolCall: type: object properties: type: const: web_search_call id: type: string action: $ref: '#/components/schemas/WebSearchAction' status: type: string required: - type - id - action - status title: Web search call item description: >- Web search call item: A web-search tool-call record containing the executed action and status. FunctionToolCall: type: object properties: type: const: function_call arguments: type: string call_id: type: string name: type: string id: type: string status: $ref: '#/components/schemas/Status' required: - type - arguments - call_id - name title: Function call item description: >- Function call item: A call to a function tool, including function name and JSON-string arguments. FunctionToolCallOutput: type: object properties: type: const: function_call_output call_id: type: string output: type: string id: type: string status: $ref: '#/components/schemas/Status' required: - type - call_id - output title: Function call output item description: >- Function call output item: The output payload returned from a function tool call. Reasoning: type: object properties: type: const: reasoning id: type: string summary: type: array items: $ref: '#/components/schemas/SummaryText' content: type: array items: $ref: '#/components/schemas/ReasoningText' encrypted_content: anyOf: - type: string - type: 'null' status: anyOf: - $ref: '#/components/schemas/Status' - type: 'null' required: - type - id - summary title: Reasoning item description: >- Reasoning item: Model reasoning metadata, including summary text and optional detailed reasoning content. ImageGenerationCall: type: object properties: type: const: image_generation_call id: type: string status: type: string result: type: string background: type: string output_format: type: string quality: type: string size: type: string revised_prompt: type: string required: - type - id - status - result title: Image generation call item description: >- Image generation call item: A tool-call record for image generation, including status and result URL. CodeInterpreterToolCall: type: object properties: type: const: code_interpreter_call id: type: string code: anyOf: - type: string - type: 'null' container_id: type: string outputs: anyOf: - type: array items: $ref: '#/components/schemas/CodeInterpreterOutput' - type: 'null' status: enum: - in_progress - completed - incomplete - interpreting - failed type: string required: - type - id - code - container_id - outputs - status title: Code interpreter call item description: >- Code interpreter call item: A tool-call record for code execution, including code, container, outputs, and status. LocalShellCall: type: object properties: type: const: local_shell_call id: type: string call_id: type: string action: $ref: '#/components/schemas/LocalShellAction' status: type: string required: - type - id - call_id - action - status title: Local shell call item description: >- Local shell call item: A local-shell execution request with command details and execution status. LocalShellCallOutput: type: object properties: type: const: local_shell_call_output id: type: string output: type: string status: $ref: '#/components/schemas/Status' required: - type - id - output title: Local shell call output item description: >- Local shell call output item: The captured output payload returned by a local-shell tool call. ShellCall: type: object properties: type: const: shell_call id: type: string call_id: type: string action: $ref: '#/components/schemas/ShellCallAction' status: enum: - in_progress - completed - incomplete type: string required: - type - id - call_id - action - status title: Shell call item description: >- Shell call item: A hosted-container shell execution request with a command and status. ShellCallOutput: type: object properties: type: const: shell_call_output id: type: string call_id: type: string output: type: object properties: stdout: type: string description: Standard output from the command. stderr: type: string description: Standard error from the command. outcome: type: object properties: type: enum: - exit - timeout type: string description: Whether the command exited normally or timed out. exit_code: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Exit code of the command, or null if timed out. required: - type - exit_code required: - stdout - stderr - outcome description: Result of the executed command. status: $ref: '#/components/schemas/Status' required: - type - id - call_id - output title: Shell call output item description: >- Shell call output item: The captured output from a hosted-container shell tool call. MCPListTools: type: object properties: type: const: mcp_list_tools id: type: string server_label: type: string tools: type: array items: $ref: '#/components/schemas/MCPTool' error: type: string required: - type - id - server_label - tools title: MCP list tools item description: >- MCP list tools item: Result of discovering available tools from an MCP server. MCPApprovalRequest: type: object properties: type: const: mcp_approval_request id: type: string arguments: type: string name: type: string server_label: type: string required: - type - id - arguments - name - server_label title: MCP approval request item description: >- MCP approval request item: A request to approve or deny execution of an MCP tool call. MCPApprovalResponse: type: object properties: type: const: mcp_approval_response approval_request_id: type: string approve: type: boolean id: type: string reason: type: string required: - type - approval_request_id - approve title: MCP approval response item description: >- MCP approval response item: The decision payload for a prior MCP approval request. MCPToolCall: type: object properties: type: const: mcp_call id: type: string arguments: type: string name: type: string server_label: type: string error: type: string output: type: string required: - type - id - arguments - name - server_label title: MCP call item description: >- MCP call item: A direct call record for an MCP tool, including request arguments and optional output/error. CustomToolCall: type: object properties: type: const: custom_tool_call call_id: type: string input: type: string name: type: string id: type: string required: - type - call_id - input - name title: Custom tool call item description: >- Custom tool call item: A call record for a custom tool with input payload and tool name. CustomToolCallOutput: type: object properties: type: const: custom_tool_call_output call_id: type: string output: type: string id: type: string required: - type - call_id - output title: Custom tool call output item description: >- Custom tool call output item: The output payload returned by a custom tool call. ItemReference: type: object properties: type: const: item_reference default: item_reference id: type: string required: - id title: Item reference item description: 'Item reference item: A pointer to another response item by ID.' ResponseCompactionItem: type: object properties: type: const: compaction id: type: string content: type: string description: The compacted/summarized conversation content. encrypted_content: type: string description: Optional encrypted content for OpenAI API compatibility. created_by: type: string description: The model that created this compaction. required: - type - id - content title: Compaction item description: >- Compaction item: A condensed summary of prior conversation history to reduce context size. InputText: type: object properties: type: const: input_text description: The content type identifier for text input. text: type: string description: The text content to send to the model. required: - type - text title: Input text content item description: 'Input text content item: Plain text content to send to the model.' InputImage: type: object properties: type: const: input_image description: The content type identifier for image input. detail: enum: - high - low - auto type: string default: auto description: >- The detail level for image processing. 'high' for detailed analysis (higher cost), 'low' for basic analysis (lower cost), 'auto' lets the model choose based on image size. Defaults to 'auto'. file_id: type: string description: >- The ID of a previously uploaded file containing the image. Mutually exclusive with image_url. image_url: type: string description: >- A URL or data URI pointing to the image. Mutually exclusive with file_id. required: - type title: Input image content item description: >- Input image content item: Image input for multimodal analysis. Provide either file_id or image_url. InputFile: type: object properties: type: const: input_file description: The content type identifier for file input. file_data: type: string description: >- Base64-encoded file data for inline file uploads. Mutually exclusive with file_id and file_url. file_id: type: string description: >- The ID of a previously uploaded file. Mutually exclusive with file_data and file_url. file_url: type: string description: >- A URL pointing to the file to process. Mutually exclusive with file_data and file_id. filename: type: string description: The original filename for display and reference purposes. required: - type title: Input file content item description: >- Input file content item: File input for document processing. Provide one of file_data, file_id, or file_url. InputAudio: type: object properties: type: const: input_audio description: The content type identifier for audio input. input_audio: type: object properties: data: type: string description: Base64-encoded audio data to send to the model. format: enum: - mp3 - wav type: string description: The audio format/codec. Supported formats are 'mp3' and 'wav'. required: - data - format description: The audio data and its format. required: - type - input_audio title: Input audio content item description: >- Input audio content item: Audio input for speech processing and transcription. OutputText: type: object properties: type: const: output_text description: The content type identifier for text output. text: type: string description: The generated text content from the model. annotations: type: array items: anyOf: - $ref: '#/components/schemas/FileCitation' - $ref: '#/components/schemas/URLCitation' - $ref: '#/components/schemas/ContainerFileCitation' - $ref: '#/components/schemas/FilePath' default: [] description: >- Array of annotations providing citations and references for the text. Used to attribute sources and reference files mentioned in the output. logprobs: type: array items: $ref: '#/components/schemas/LogProb' required: - type - text description: >- Text content output from the model with optional annotations for citations and file references. Refusal: type: object properties: type: const: refusal description: The content type identifier for refusal responses. refusal: type: string description: >- The refusal message explaining why the model declined to respond to the request. required: - type - refusal description: >- Refusal response when the model declines to answer due to safety policies, content moderation, or capability limitations. FileSearchResult: type: object properties: attributes: type: object propertyNames: type: string additionalProperties: anyOf: - type: string - type: boolean - type: number file_id: type: string filename: type: string score: type: number text: type: string ComputerAction: anyOf: - $ref: '#/components/schemas/ClickAction' - $ref: '#/components/schemas/DoubleClickAction' - $ref: '#/components/schemas/DragAction' - $ref: '#/components/schemas/KeyPressAction' - $ref: '#/components/schemas/MoveAction' - $ref: '#/components/schemas/ScreenshotAction' - $ref: '#/components/schemas/ScrollAction' - $ref: '#/components/schemas/TypeAction' - $ref: '#/components/schemas/WaitAction' PendingSafetyCheck: type: object properties: code: type: string id: type: string message: type: string required: - code - id - message ComputerScreenshot: type: object properties: type: const: computer_screenshot file_id: type: string image_url: type: string required: - type AcknowledgedSafetyCheck: type: object properties: id: type: string code: type: string message: type: string required: - id WebSearchAction: anyOf: - $ref: '#/components/schemas/SearchAction' - $ref: '#/components/schemas/OpenPageAction' - $ref: '#/components/schemas/FindAction' SummaryText: type: object properties: type: const: summary_text text: type: string required: - type - text ReasoningText: type: object properties: type: const: reasoning_text text: type: string required: - type - text CodeInterpreterOutput: anyOf: - $ref: '#/components/schemas/CodeInterpreterOutputLogs' - $ref: '#/components/schemas/CodeInterpreterOutputImage' LocalShellAction: type: object properties: type: const: exec command: type: array items: type: string env: type: object propertyNames: type: string additionalProperties: type: string timeout_ms: type: integer minimum: -9007199254740991 maximum: 9007199254740991 user: type: string working_directory: type: string required: - type - command - env ShellCallAction: type: object properties: type: const: exec command: type: string description: Shell command to execute. timeout_ms: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Command timeout in milliseconds. max_output_length: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Maximum output characters. required: - type MCPTool: type: object properties: name: type: string input_schema: type: object propertyNames: type: string additionalProperties: {} annotations: type: object propertyNames: type: string additionalProperties: {} description: type: string required: - name - input_schema FileCitation: type: object properties: type: const: file_citation description: The annotation type identifier for file citations. file_id: type: string description: The ID of the file being cited. filename: type: string description: The name of the file being cited. index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The character index in the output text where this citation applies. required: - type - file_id - filename - index description: >- Annotation for citing a specific file in the model's output. Used when the model references information from a file. URLCitation: type: object properties: type: const: url_citation description: The annotation type identifier for URL citations. end_index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The character index where the cited text ends in the output. start_index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The character index where the cited text begins in the output. title: type: string description: The title of the web page or resource being cited. url: type: string description: The URL of the web resource being cited. required: - type - end_index - start_index - title - url description: >- Annotation for citing a web URL in the model's output. Used when the model references information from web sources. ContainerFileCitation: type: object properties: type: const: container_file_citation description: The annotation type identifier for container file citations. container_id: type: string description: >- The ID of the container (e.g., code interpreter container) where the file resides. end_index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The character index where the cited text ends in the output. file_id: type: string description: The ID of the file within the container being cited. filename: type: string description: The name of the file being cited. start_index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The character index where the cited text begins in the output. required: - type - container_id - end_index - file_id - filename - start_index description: >- Annotation for citing a file within a specific container (like a code interpreter sandbox). Used when the model references files generated within tool executions. FilePath: type: object properties: type: const: file_path description: The annotation type identifier for file path references. file_id: type: string description: The ID of the file being referenced. index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The character index in the output text where this file path reference applies. required: - type - file_id - index description: >- Annotation for referencing a file path in the model's output. Used when the model mentions specific files. LogProb: type: object properties: token: type: string logprob: type: number bytes: type: array items: type: number top_logprobs: type: array items: $ref: '#/components/schemas/TopLogProb' required: - token - logprob - bytes - top_logprobs ClickAction: type: object properties: type: const: click button: enum: - left - right - wheel - back - forward type: string x: type: integer minimum: -9007199254740991 maximum: 9007199254740991 'y': type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - type - button - x - 'y' DoubleClickAction: type: object properties: type: const: double_click x: type: integer minimum: -9007199254740991 maximum: 9007199254740991 'y': type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - type - x - 'y' DragAction: type: object properties: type: const: drag path: type: array items: type: object properties: x: type: integer minimum: -9007199254740991 maximum: 9007199254740991 'y': type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - x - 'y' required: - type - path KeyPressAction: type: object properties: type: const: keypress keys: type: array items: type: string required: - type - keys MoveAction: type: object properties: type: const: move x: type: integer minimum: -9007199254740991 maximum: 9007199254740991 'y': type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - type - x - 'y' ScreenshotAction: type: object properties: type: const: screenshot required: - type ScrollAction: type: object properties: type: const: scroll scroll_x: type: integer minimum: -9007199254740991 maximum: 9007199254740991 scroll_y: type: integer minimum: -9007199254740991 maximum: 9007199254740991 x: type: integer minimum: -9007199254740991 maximum: 9007199254740991 'y': type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - type - scroll_x - scroll_y - x - 'y' TypeAction: type: object properties: type: const: type text: type: string required: - type - text WaitAction: type: object properties: type: const: wait required: - type SearchAction: type: object properties: type: const: search query: type: string sources: type: array items: $ref: '#/components/schemas/SearchActionSource' required: - type - query OpenPageAction: type: object properties: type: const: open_page url: type: string required: - type - url FindAction: type: object properties: type: const: find pattern: type: string url: type: string required: - type - pattern - url CodeInterpreterOutputLogs: type: object properties: type: const: logs logs: type: string required: - type - logs CodeInterpreterOutputImage: type: object properties: type: const: image url: type: string required: - type - url TopLogProb: type: object properties: token: type: string logprob: type: number bytes: type: array items: type: number required: - token - logprob - bytes SearchActionSource: type: object properties: type: const: url url: type: string required: - type - url securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Gateway auth: send `Authorization: Bearer `. For multi-user server-side integrations, you can also send `X-On-Behalf-Of: `. ````