Create a conversation

Create a conversation.

Request

POST

https://ai.api.cloud.yandex.net/v1/conversations

Body

application/json

{
  "metadata": {},
  "items": [
    {}
  ]
}

Name	Description
items	Any of 2 types Type: InputItem[] Initial items to include in the conversation context. You may add up to 20 items at a time. Max items: `20` Example `[ { "type": "message", "role": "user", "status": "in_progress", "content": [ null ] } ]` Type: null Example: `null` Example `[ { "type": "message", "role": "user", "status": "in_progress", "content": [ null ] } ]`
metadata	Any of 2 types Type: Metadata Set of 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. Set of 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. Example `{}` Type: null Example: `null` Example `{}`

Set of 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.

Name

Description

[additional]

Type: string

Example: example

Example

{}

InputTextContent

A text input to the model.

Name

Description

text

Type: string

The text input to the model.

Example: example

type

Type: string

The type of the input item. Always input_text.

Default: input_text

Const: input_text

Example

{
  "type": "input_text",
  "text": "example"
}

ImageDetail

Type: string

Enum: low, high, auto, original

InputImageContent

An image input to the model.

Name	Description
detail	Type: ImageDetail The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. Enum: `low`, `high`, `auto`, `original`
type	Type: string The type of the input item. Always `input_image`. Default: `input_image` Const: `input_image`
file_id	Type: string The ID of the file to be sent to the model. Example: `example`
image_url	Type: string The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. Example: `example`

Example

{
  "type": "input_image",
  "image_url": "example",
  "file_id": "example",
  "detail": "low"
}

FileInputDetail

Type: string

Enum: low, high

InputFileContent

A file input to the model.

Name	Description
type	Type: string The type of the input item. Always `input_file`. Default: `input_file` Const: `input_file`
detail	Type: FileInputDetail The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. Enum: `low`, `high`
file_data	Type: string The content of the file to be sent to the model. Example: `example`
file_id	Type: string The ID of the file to be sent to the model. Example: `example`
file_url	Type: string The URL of the file to be sent to the model. Example: `example`
filename	Type: string The name of the file to be sent to the model. Example: `example`

Example

{
  "type": "input_file",
  "file_id": "example",
  "filename": "example",
  "file_data": "example",
  "file_url": "example",
  "detail": "low"
}

InputContent

One of 3 types

Input text

Type: InputTextContent

A text input to the model.
Example
```
{
  "type": "input_text",
  "text": "example"
}
```

Input image

Type: InputImageContent

An image input to the model.

Example

{
  "type": "input_image",
  "image_url": "example",
  "file_id": "example",
  "detail": "low"
}

Input file

Type: InputFileContent

A file input to the model.

Example

{
  "type": "input_file",
  "file_id": "example",
  "filename": "example",
  "file_data": "example",
  "file_url": "example",
  "detail": "low"
}

Example

{
  "type": "input_text",
  "text": "example"
}

InputMessageContentList

A list of one or many input items to the model, containing different content types.

Type: InputContent[]

Example

[
  {
    "type": "input_text",
    "text": "example"
  }
]

InputMessage

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role.

Name	Description
content	Type: InputMessageContentList A list of one or many input items to the model, containing different content types. Example `[ { "type": "input_text", "text": "example" } ]`
role	Type: string The role of the message input. One of `user`, `system`, or `developer`. Enum: `user`, `system`, `developer`
status	Type: string The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. Enum: `in_progress`, `completed`, `incomplete`
type	Type: string The type of the message input. Always set to `message`. Const: `message` Example: `example`

Example

{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {
      "type": "input_text",
      "text": "example"
    }
  ]
}

FileCitationBody

A citation to a file.

Name	Description
file_id	Type: string The ID of the file. Example: `example`
filename	Type: string The filename of the file cited. Example: `example`
index	Type: integer The index of the file in the list of files.
type	Type: string The type of the file citation. Always `file_citation`. Default: `file_citation` Const: `file_citation`

Example

{
  "type": "file_citation",
  "file_id": "example",
  "index": 0,
  "filename": "example"
}

UrlCitationBody

A citation for a web resource used to generate a model response.

Name	Description
end_index	Type: integer The index of the last character of the URL citation in the message.
start_index	Type: integer The index of the first character of the URL citation in the message.
title	Type: string The title of the web resource. Example: `example`
type	Type: string The type of the URL citation. Always `url_citation`. Default: `url_citation` Const: `url_citation`
url	Type: string The URL of the web resource. Example: `example`

Example

{
  "type": "url_citation",
  "url": "example",
  "start_index": 0,
  "end_index": 0,
  "title": "example"
}

ContainerFileCitationBody

A citation for a container file used to generate a model response.

Name	Description
container_id	Type: string The ID of the container file. Example: `example`
end_index	Type: integer The index of the last character of the container file citation in the message.
file_id	Type: string The ID of the file. Example: `example`
filename	Type: string The filename of the container file cited. Example: `example`
start_index	Type: integer The index of the first character of the container file citation in the message.
type	Type: string The type of the container file citation. Always `container_file_citation`. Default: `container_file_citation` Const: `container_file_citation`

Example

{
  "type": "container_file_citation",
  "container_id": "example",
  "file_id": "example",
  "start_index": 0,
  "end_index": 0,
  "filename": "example"
}

FilePath

A path to a file.

Name	Description
file_id	Type: string The ID of the file. Example: `example`
index	Type: integer The index of the file in the list of files.
type	Type: string The type of the file path. Always `file_path`. Const: `file_path` Example: `example`

Example

{
  "type": "file_path",
  "file_id": "example",
  "index": 0
}

Annotation

An annotation that applies to a span of output text.

One of 4 types

File citation

Type: FileCitationBody

A citation to a file.

Example

{
  "type": "file_citation",
  "file_id": "example",
  "index": 0,
  "filename": "example"
}

URL citation

Type: UrlCitationBody

A citation for a web resource used to generate a model response.

Example

{
  "type": "url_citation",
  "url": "example",
  "start_index": 0,
  "end_index": 0,
  "title": "example"
}

Container file citation

Type: ContainerFileCitationBody

A citation for a container file used to generate a model response.

Example

{
  "type": "container_file_citation",
  "container_id": "example",
  "file_id": "example",
  "start_index": 0,
  "end_index": 0,
  "filename": "example"
}

File path

Type: FilePath

A path to a file.

Example

{
  "type": "file_path",
  "file_id": "example",
  "index": 0
}

Example

{
  "type": "file_citation",
  "file_id": "example",
  "index": 0,
  "filename": "example"
}

TopLogProb

The top log probability of a token.

Name	Description
bytes	Type: integer[] Example `[ 0 ]`
logprob	Type: number
token	Type: string Example: `example`

Example

{
  "token": "example",
  "logprob": 0.5,
  "bytes": [
    0
  ]
}

LogProb

The log probability of a token.

Name	Description
bytes	Type: integer[] Example `[ 0 ]`
logprob	Type: number
token	Type: string Example: `example`
top_logprobs	Type: TopLogProb[] Example `[ { "token": "example", "logprob": 0.5, "bytes": [ 0 ] } ]`

Example

{
  "token": "example",
  "logprob": 0.5,
  "bytes": [
    0
  ],
  "top_logprobs": [
    {
      "token": "example",
      "logprob": 0.5,
      "bytes": [
        0
      ]
    }
  ]
}

OutputTextContent

A text output from the model.

Name	Description
annotations	Type: Annotation[] The annotations of the text output. Example `[ { "type": "file_citation", "file_id": "example", "index": 0, "filename": "example" } ]`
logprobs	Type: LogProb[] Example `[ { "token": "example", "logprob": 0.5, "bytes": [ 0 ], "top_logprobs": [ { "token": "example", "logprob": 0.5, "bytes": [ 0 ] } ] } ]`
text	Type: string The text output from the model. Example: `example`
type	Type: string The type of the output text. Always `output_text`. Default: `output_text` Const: `output_text`

Example

{
  "type": "output_text",
  "text": "example",
  "annotations": [
    {
      "type": "file_citation",
      "file_id": "example",
      "index": 0,
      "filename": "example"
    }
  ],
  "logprobs": [
    {
      "token": "example",
      "logprob": 0.5,
      "bytes": [
        0
      ],
      "top_logprobs": [
        {
          "token": "example",
          "logprob": 0.5,
          "bytes": [
            null
          ]
        }
      ]
    }
  ]
}

RefusalContent

A refusal from the model.

Name

Description

refusal

Type: string

The refusal explanation from the model.

Example: example

type

Type: string

The type of the refusal. Always refusal.

Default: refusal

Const: refusal

Example

{
  "type": "refusal",
  "refusal": "example"
}

OutputMessageContent

One of 2 types

Output text

Type: OutputTextContent

A text output from the model.

Example

{
  "type": "output_text",
  "text": "example",
  "annotations": [
    {
      "type": "file_citation",
      "file_id": "example",
      "index": 0,
      "filename": "example"
    }
  ],
  "logprobs": [
    {
      "token": "example",
      "logprob": 0.5,
      "bytes": [
        0
      ],
      "top_logprobs": [
        {
          "token": "example",
          "logprob": 0.5,
          "bytes": [
            null
          ]
        }
      ]
    }
  ]
}

Refusal

Type: RefusalContent

A refusal from the model.

Example

{
  "type": "refusal",
  "refusal": "example"
}

Example

{
  "type": "output_text",
  "text": "example",
  "annotations": [
    {
      "type": "file_citation",
      "file_id": "example",
      "index": 0,
      "filename": "example"
    }
  ],
  "logprobs": [
    {
      "token": "example",
      "logprob": 0.5,
      "bytes": [
        0
      ],
      "top_logprobs": [
        {}
      ]
    }
  ]
}

MessagePhase

Labels an assistant message as intermediate commentary (commentary) or the final answer (final_answer). Not used for user messages.

Type: string

Enum: commentary, final_answer

OutputMessage

An output message from the model.

Name	Description
content	Type: OutputMessageContent[] The content of the output message. Example `[ { "type": "output_text", "text": "example", "annotations": [ {} ], "logprobs": [ { "token": "example", "logprob": 0.5, "bytes": [ null ], "top_logprobs": [ null ] } ] } ]`
id	Type: string The unique ID of the output message. Example: `example`
role	Type: string The role of the output message. Always `assistant`. Const: `assistant` Example: `example`
status	Type: string The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API. Enum: `in_progress`, `completed`, `incomplete`
type	Type: string The type of the output message. Always `message`. Const: `message` Example: `example`
phase	Type: MessagePhase Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). Not used for user messages. Enum: `commentary`, `final_answer`

Example

{
  "id": "example",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "output_text",
      "text": "example",
      "annotations": [
        null
      ],
      "logprobs": [
        {}
      ]
    }
  ],
  "phase": "commentary",
  "status": "in_progress"
}

VectorStoreFileAttributes

Any of 2 types

Type: object
[additional]

One of 3 types

Type: string

Max length: 512

Example: example

Type: number

Type: boolean

Example: example
Set of 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.

Max properties: 16
Example
```
{}
```
Type: unknown

Example: null

Default: null

FileSearchToolCall

The results of a File Search tool call.

Name

Description

Type: string

The unique ID of the file search tool call.

Example: example

queries

Type: string[]

The queries used to search for files.

Example

[
  "example"
]

status

Type: string

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

Enum: in_progress, searching, completed, incomplete, failed

type

Type: string

The type of the file search tool call. Always file_search_call.

Const: file_search_call

Example: example

results

Type: object[]

attributes	Type: VectorStoreFileAttributes Default: `null` Example `{}`
file_id	Type: string The unique ID of the file. Example: `example`
filename	Type: string The name of the file. Example: `example`
score	Type: number The relevance score of the file - a value between 0 and 1.
text	Type: string The text that was retrieved from the file. Example: `example`

The results of the file search tool call.

Example

[
  {
    "file_id": "example",
    "text": "example",
    "filename": "example",
    "attributes": null,
    "score": 0.5
  }
]

Example

{
  "id": "example",
  "type": "file_search_call",
  "status": "in_progress",
  "queries": [
    "example"
  ],
  "results": [
    {
      "file_id": "example",
      "text": "example",
      "filename": "example",
      "attributes": null,
      "score": 0.5
    }
  ]
}

WebSearchActionSearch

Action type "search" - Performs a web search query.

Name

Description

query

Type: string

[DEPRECATED] The search query.

Example: example

type

Type: string

The action type.

Const: search

Example: example

queries

Type: string[]

The search queries.

Example

[
  "example"
]

sources

Type: Web search source

type

Type: string

The type of source. Always url.

Const: url

Example: example

url

Type: string

The URL of the source.

Example: example

The sources used in the search.

Example

[
  {
    "type": "url",
    "url": "example"
  }
]

Example

{
  "type": "search",
  "query": "example",
  "queries": [
    "example"
  ],
  "sources": [
    {
      "type": "url",
      "url": "example"
    }
  ]
}

WebSearchActionOpenPage

Action type "open_page" - Opens a specific URL from search results.

Name

Description

type

Type: string

The action type.

Const: open_page

Example: example

url

Type: string<uri>

The URL opened by the model.

Example: https://example.com

Example

{
  "type": "open_page",
  "url": "https://example.com"
}

WebSearchActionFind

Action type "find_in_page": Searches for a pattern within a loaded page.

Name	Description
pattern	Type: string The pattern or text to search for within the page. Example: `example`
type	Type: string The action type. Const: `find_in_page` Example: `example`
url	Type: string<uri> The URL of the page searched for the pattern. Example: `https://example.com`

Example

{
  "type": "find_in_page",
  "url": "https://example.com",
  "pattern": "example"
}

WebSearchToolCall

The results of a web search tool call.

Name	Description
action	Type: object One of 3 types Search action Type: WebSearchActionSearch Action type "search" - Performs a web search query. Example `{ "type": "search", "query": "example", "queries": [ "example" ], "sources": [ { "type": "url", "url": "example" } ] }` Open page action Type: WebSearchActionOpenPage Action type "open_page" - Opens a specific URL from search results. Example `{ "type": "open_page", "url": "https://example.com" }` Find action Type: WebSearchActionFind Action type "find_in_page": Searches for a pattern within a loaded page. Example `{ "type": "find_in_page", "url": "https://example.com", "pattern": "example" }` An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page). Example `{ "type": "search", "query": "example", "queries": [ "example" ], "sources": [ { "type": "url", "url": "example" } ] }`
id	Type: string The unique ID of the web search tool call. Example: `example`
status	Type: string The status of the web search tool call. Enum: `in_progress`, `searching`, `completed`, `failed`
type	Type: string The type of the web search tool call. Always `web_search_call`. Const: `web_search_call` Example: `example`

Example

{
  "id": "example",
  "type": "web_search_call",
  "status": "in_progress",
  "action": {
    "type": "search",
    "query": "example",
    "queries": [
      "example"
    ],
    "sources": [
      {
        "type": "url",
        "url": "example"
      }
    ]
  }
}

FunctionToolCall

A tool call to run a function.

Name	Description
arguments	Type: string A JSON string of the arguments to pass to the function. Example: `example`
call_id	Type: string The unique ID of the function tool call generated by the model. Example: `example`
name	Type: string The name of the function to run. Example: `example`
type	Type: string The type of the function tool call. Always `function_call`. Const: `function_call` Example: `example`
id	Type: string The unique ID of the function tool call. Example: `example`
namespace	Type: string The namespace of the function to run. Example: `example`
status	Type: string The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. Enum: `in_progress`, `completed`, `incomplete`

Example

{
  "id": "example",
  "type": "function_call",
  "call_id": "example",
  "namespace": "example",
  "name": "example",
  "arguments": "example",
  "status": "in_progress"
}

InputTextContentParam

A text input to the model.

Name

Description

text

Type: string

The text input to the model.

Max length: 10485760

Example: example

type

Type: string

The type of the input item. Always input_text.

Default: input_text

Const: input_text

Example

{
  "type": "input_text",
  "text": "example"
}

InputImageContentParamAutoParam

An image input to the model.

Name	Description
type	Type: string The type of the input item. Always `input_image`. Default: `input_image` Const: `input_image`
detail	Type: DetailEnum The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. Enum: `low`, `high`, `auto`, `original`
file_id	Type: string The ID of the file to be sent to the model. Example: `fvtdeb81rt1d978c5hvb`
image_url	Type: string The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. Max length: `20971520` Example: `example`

Example

{
  "type": "input_image",
  "image_url": "example",
  "file_id": "fvtdeb81rt1d978c5hvb",
  "detail": "low"
}

InputFileContentParam

A file input to the model.

Name	Description
type	Type: string The type of the input item. Always `input_file`. Default: `input_file` Const: `input_file`
detail	Type: FileDetailEnum The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. Enum: `low`, `high`
file_data	Type: string The base64-encoded data of the file to be sent to the model. Max length: `73400320` Example: `example`
file_id	Type: string The ID of the file to be sent to the model. Example: `fvtdeb81rt1d978c5hvb`
file_url	Type: string The URL of the file to be sent to the model. Example: `example`
filename	Type: string The name of the file to be sent to the model. Example: `example`

Example

{
  "type": "input_file",
  "file_id": "fvtdeb81rt1d978c5hvb",
  "filename": "example",
  "file_data": "example",
  "file_url": "example",
  "detail": "low"
}

FunctionCallItemStatus

Type: string

Enum: in_progress, completed, incomplete

FunctionCallOutputItemParam

The output of a function tool call.

Name	Description
call_id	Type: string The unique ID of the function tool call generated by the model. Min length: `1` Max length: `64` Example: `example`
output	One of 2 types Type: string A JSON string of the output of the function tool call. Max length: `10485760` Example: `example` Type: array One of 3 types Input text Type: InputTextContentParam A text input to the model. Example `{ "type": "input_text", "text": "example" }` Input image Type: InputImageContentParamAutoParam An image input to the model. Example `{ "type": "input_image", "image_url": "example", "file_id": "fvtdeb81rt1d978c5hvb", "detail": "low" }` Input file Type: InputFileContentParam A file input to the model. Example `{ "type": "input_file", "file_id": "fvtdeb81rt1d978c5hvb", "filename": "example", "file_data": "example", "file_url": "example", "detail": "low" }` An array of content outputs (text, image, file) for the function tool call. Example `[ { "type": "input_text", "text": "example" } ]` Text, image, or file output of the function tool call. Example: `example`
type	Type: string The type of the function tool call output. Always `function_call_output`. Default: `function_call_output` Const: `function_call_output`
id	Type: string The unique ID of the function tool call output. Populated when this item is returned via API. Example: `example`
status	Type: FunctionCallItemStatus The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. Enum: `in_progress`, `completed`, `incomplete`

Example

{
  "id": "example",
  "call_id": "example",
  "type": "function_call_output",
  "output": "example",
  "status": "in_progress"
}

SummaryTextContent

A summary text from the model.

Name

Description

text

Type: string

A summary of the reasoning output from the model so far.

Example: example

type

Type: string

The type of the object. Always summary_text.

Default: summary_text

Const: summary_text

Example

{
  "type": "summary_text",
  "text": "example"
}

ReasoningTextContent

Reasoning text from the model.

Name

Description

text

Type: string

The reasoning text from the model.

Example: example

type

Type: string

The type of the reasoning text. Always reasoning_text.

Default: reasoning_text

Const: reasoning_text

Example

{
  "type": "reasoning_text",
  "text": "example"
}

ReasoningItem

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

Name	Description
id	Type: string The unique identifier of the reasoning content. Example: `example`
summary	Type: SummaryTextContent[] Reasoning summary content. Example `[ { "type": "summary_text", "text": "example" } ]`
type	Type: string The type of the object. Always `reasoning`. Const: `reasoning` Example: `example`
content	Type: ReasoningTextContent[] Reasoning text content. Example `[ { "type": "reasoning_text", "text": "example" } ]`
encrypted_content	Type: string The encrypted content of the reasoning item - populated when a response is generated with `reasoning.encrypted_content` in the `include` parameter. Example: `example`
status	Type: string The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. Enum: `in_progress`, `completed`, `incomplete`

Example

{
  "type": "reasoning",
  "id": "example",
  "encrypted_content": "example",
  "summary": [
    {
      "type": "summary_text",
      "text": "example"
    }
  ],
  "content": [
    {
      "type": "reasoning_text",
      "text": "example"
    }
  ],
  "status": "in_progress"
}

CompactionSummaryItemParam

A compaction item generated by the v1/responses/compact API.

Name	Description
encrypted_content	Type: string The encrypted content of the compaction summary. Max length: `10485760` Example: `example`
type	Type: string The type of the item. Always `compaction`. Default: `compaction` Const: `compaction`
id	Type: string The ID of the compaction item. Example: `example`

Example

{
  "id": "example",
  "type": "compaction",
  "encrypted_content": "example"
}

ImageGenToolCall

An image generation request made by the model.

Name	Description
id	Type: string The unique ID of the image generation call. Example: `example`
result	Type: string The generated image encoded in base64. Example: `example`
status	Type: string The status of the image generation call. Enum: `in_progress`, `completed`, `generating`, `failed`
type	Type: string The type of the image generation call. Always `image_generation_call`. Const: `image_generation_call` Example: `example`

Example

{
  "type": "image_generation_call",
  "id": "example",
  "status": "in_progress",
  "result": "example"
}

CodeInterpreterOutputLogs

The logs output from the code interpreter.

Name

Description

logs

Type: string

The logs output from the code interpreter.

Example: example

type

Type: string

The type of the output. Always logs.

Default: logs

Const: logs

Example

{
  "type": "logs",
  "logs": "example"
}

CodeInterpreterOutputImage

The image output from the code interpreter.

Name

Description

type

Type: string

The type of the output. Always image.

Default: image

Const: image

url

Type: string

The URL of the image output from the code interpreter.

Example: example

Example

{
  "type": "image",
  "url": "example"
}

CodeInterpreterToolCall

A tool call to run code.

Name	Description
code	Type: string The code to run, or null if not available. Example: `example`
container_id	Type: string The ID of the container used to run the code. Example: `example`
id	Type: string The unique ID of the code interpreter tool call. Example: `example`
outputs	Type: array One of 2 types Code interpreter output logs Type: CodeInterpreterOutputLogs The logs output from the code interpreter. Example `{ "type": "logs", "logs": "example" }` Code interpreter output image Type: CodeInterpreterOutputImage The image output from the code interpreter. Example `{ "type": "image", "url": "example" }` The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available. Example `[ { "type": "logs", "logs": "example" } ]`
status	Type: string The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. Enum: `in_progress`, `completed`, `incomplete`, `interpreting`, `failed`
type	Type: string The type of the code interpreter tool call. Always `code_interpreter_call`. Default: `code_interpreter_call` Const: `code_interpreter_call`

Example

{
  "type": "code_interpreter_call",
  "id": "example",
  "status": "in_progress",
  "container_id": "example",
  "code": "example",
  "outputs": [
    {
      "type": "logs",
      "logs": "example"
    }
  ]
}

FunctionShellAction

Execute a shell command.

Name	Description
commands	Type: string[] Example `[ "example" ]`
max_output_length	Any of 2 types Type: integer Optional maximum number of characters to return from each command. Type: null Example: `null` Example: `0`
timeout_ms	Any of 2 types Type: integer Optional timeout in milliseconds for the commands. Type: null Example: `null` Example: `0`

Example

{
  "commands": [
    "example"
  ],
  "timeout_ms": 0,
  "max_output_length": 0
}

ContainerReferenceResource

Represents a container created with /v1/containers.

Name

Description

container_id

Type: string

Example: example

type

Type: string

The environment type. Always container_reference.

Default: container_reference

Const: container_reference

Example

{
  "type": "container_reference",
  "container_id": "example"
}

FunctionShellCall

A tool call that executes one or more shell commands in a managed environment.

Name	Description
action	Type: FunctionShellAction The shell commands and limits that describe how to run the tool call. Execute a shell command. Example `{ "commands": [ "example" ], "timeout_ms": 0, "max_output_length": 0 }`
call_id	Type: string The unique ID of the shell tool call generated by the model. Example: `example`
environment	Any of 2 types Container Reference Type: ContainerReferenceResource Represents a container created with /v1/containers. Example `{ "type": "container_reference", "container_id": "example" }` Type: null Example: `null` Example `{ "type": "container_reference", "container_id": "example" }`
id	Type: string The unique ID of the shell tool call. Populated when this item is returned via API. Example: `example`
status	Type: LocalShellCallStatus The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. Enum: `in_progress`, `completed`, `incomplete`
type	Type: string The type of the item. Always `shell_call`. Default: `shell_call` Const: `shell_call`
created_by	Type: string The ID of the entity that created this tool call. Example: `example`

Example

{
  "type": "shell_call",
  "id": "example",
  "call_id": "example",
  "action": {
    "commands": [
      "example"
    ],
    "timeout_ms": 0,
    "max_output_length": 0
  },
  "status": "in_progress",
  "environment": {
    "type": "container_reference",
    "container_id": "example"
  },
  "created_by": "example"
}

FunctionShellCallOutputTimeoutOutcome

Indicates that the shell call exceeded its configured time limit.

Name

Description

type

Type: string

The outcome type. Always timeout.

Default: timeout

Const: timeout

Example

{
  "type": "timeout"
}

FunctionShellCallOutputExitOutcome

Indicates that the shell commands finished and returned an exit code.

Name

Description

exit_code

Type: integer

Exit code from the shell process.

type

Type: string

The outcome type. Always exit.

Default: exit

Const: exit

Example

{
  "type": "exit",
  "exit_code": 0
}

FunctionShellCallOutputContent

The content of a shell tool call output that was emitted.

Name	Description
outcome	One of 2 types Shell call timeout outcome Type: FunctionShellCallOutputTimeoutOutcome Indicates that the shell call exceeded its configured time limit. Example `{ "type": "timeout" }` Shell call exit outcome Type: FunctionShellCallOutputExitOutcome Indicates that the shell commands finished and returned an exit code. Example `{ "type": "exit", "exit_code": 0 }` Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. Example `{ "type": "timeout" }`
stderr	Type: string The standard error output that was captured. Example: `example`
stdout	Type: string The standard output that was captured. Example: `example`
created_by	Type: string The identifier of the actor that created the item. Example: `example`

Example

{
  "stdout": "example",
  "stderr": "example",
  "outcome": {
    "type": "timeout"
  },
  "created_by": "example"
}

FunctionShellCallOutput

The output of a shell tool call that was emitted.

Name	Description
call_id	Type: string The unique ID of the shell tool call generated by the model. Example: `example`
id	Type: string The unique ID of the shell call output. Populated when this item is returned via API. Example: `example`
max_output_length	Any of 2 types Type: integer The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. Type: null Example: `null` Example: `0`
output	Type: FunctionShellCallOutputContent[] An array of shell call output contents Example `[ { "stdout": "example", "stderr": "example", "outcome": { "type": "timeout" }, "created_by": "example" } ]`
status	Type: LocalShellCallOutputStatusEnum The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. Enum: `in_progress`, `completed`, `incomplete`
type	Type: string The type of the shell call output. Always `shell_call_output`. Default: `shell_call_output` Const: `shell_call_output`
created_by	Type: string The identifier of the actor that created the item. Example: `example`

Example

{
  "type": "shell_call_output",
  "id": "example",
  "call_id": "example",
  "status": "in_progress",
  "output": [
    {
      "stdout": "example",
      "stderr": "example",
      "outcome": {
        "type": "timeout"
      },
      "created_by": "example"
    }
  ],
  "max_output_length": 0,
  "created_by": "example"
}

MCPListToolsTool

A tool available on an MCP server.

Name	Description
input_schema	Type: object The JSON schema describing the tool's input. Example `{}`
name	Type: string The name of the tool. Example: `example`
annotations	Type: object Additional annotations about the tool. Example `{}`
description	Type: string The description of the tool. Example: `example`

Example

{
  "name": "example",
  "description": "example",
  "input_schema": {},
  "annotations": {}
}

MCPListTools

A list of tools available on an MCP server.

Name	Description
id	Type: string The unique ID of the list. Example: `example`
server_label	Type: string The label of the MCP server. Example: `example`
tools	Type: MCPListToolsTool[] The tools available on the server. Example `[ { "name": "example", "description": "example", "input_schema": {}, "annotations": {} } ]`
type	Type: string The type of the item. Always `mcp_list_tools`. Const: `mcp_list_tools` Example: `example`
error	Type: string Error message if the server could not list tools. Example: `example`

Example

{
  "type": "mcp_list_tools",
  "id": "example",
  "server_label": "example",
  "tools": [
    {
      "name": "example",
      "description": "example",
      "input_schema": {},
      "annotations": {}
    }
  ],
  "error": "example"
}

MCPApprovalRequest

A request for human approval of a tool invocation.

Name	Description
arguments	Type: string A JSON string of arguments for the tool. Example: `example`
id	Type: string The unique ID of the approval request. Example: `example`
name	Type: string The name of the tool to run. Example: `example`
server_label	Type: string The label of the MCP server making the request. Example: `example`
type	Type: string The type of the item. Always `mcp_approval_request`. Const: `mcp_approval_request` Example: `example`

Example

{
  "type": "mcp_approval_request",
  "id": "example",
  "server_label": "example",
  "name": "example",
  "arguments": "example"
}

MCPApprovalResponse

A response to an MCP approval request.

Name	Description
approval_request_id	Type: string The ID of the approval request being answered. Example: `example`
approve	Type: boolean Whether the request was approved.
type	Type: string The type of the item. Always `mcp_approval_response`. Const: `mcp_approval_response` Example: `example`
id	Type: string The unique ID of the approval response Example: `example`
reason	Type: string Optional reason for the decision. Example: `example`

Example

{
  "type": "mcp_approval_response",
  "id": "example",
  "approval_request_id": "example",
  "approve": true,
  "reason": "example"
}

MCPToolCallStatus

Type: string

Enum: in_progress, completed, incomplete, calling, failed

MCPToolCall

An invocation of a tool on an MCP server.

Name	Description
arguments	Type: string A JSON string of the arguments passed to the tool. Example: `example`
id	Type: string The unique ID of the tool call. Example: `example`
name	Type: string The name of the tool that was run. Example: `example`
server_label	Type: string The label of the MCP server running the tool. Example: `example`
type	Type: string The type of the item. Always `mcp_call`. Const: `mcp_call` Example: `example`
approval_request_id	Type: string Unique identifier for the MCP tool call approval request. Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call. Example: `example`
error	Type: string The error from the tool call, if any. Example: `example`
output	Type: string The output from the tool call. Example: `example`
status	Type: MCPToolCallStatus The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`. Enum: `in_progress`, `completed`, `incomplete`, `calling`, `failed`

Example

{
  "type": "mcp_call",
  "id": "example",
  "server_label": "example",
  "name": "example",
  "arguments": "example",
  "output": "example",
  "error": "example",
  "status": "in_progress",
  "approval_request_id": "example"
}

Item

Content item used to generate a response.

Type: object

One of 16 types

Input message

Type: InputMessage

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role.
Example
```
{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {
      "type": "input_text",
      "text": "example"
    }
  ]
}
```

Output message

Type: OutputMessage

An output message from the model.

Example

{
  "id": "example",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "output_text",
      "text": "example",
      "annotations": [
        null
      ],
      "logprobs": [
        {}
      ]
    }
  ],
  "phase": "commentary",
  "status": "in_progress"
}

File search tool call

Type: FileSearchToolCall

The results of a File Search tool call.

Example

{
  "id": "example",
  "type": "file_search_call",
  "status": "in_progress",
  "queries": [
    "example"
  ],
  "results": [
    {
      "file_id": "example",
      "text": "example",
      "filename": "example",
      "attributes": null,
      "score": 0.5
    }
  ]
}

Web search tool call

Type: WebSearchToolCall

The results of a web search tool call.

Example

{
  "id": "example",
  "type": "web_search_call",
  "status": "in_progress",
  "action": {
    "type": "search",
    "query": "example",
    "queries": [
      "example"
    ],
    "sources": [
      {
        "type": "url",
        "url": "example"
      }
    ]
  }
}

Function tool call

Type: FunctionToolCall

A tool call to run a function.

Example

{
  "id": "example",
  "type": "function_call",
  "call_id": "example",
  "namespace": "example",
  "name": "example",
  "arguments": "example",
  "status": "in_progress"
}

Function tool call output

Type: FunctionCallOutputItemParam

The output of a function tool call.

Example

{
  "id": "example",
  "call_id": "example",
  "type": "function_call_output",
  "output": "example",
  "status": "in_progress"
}

Reasoning

Type: ReasoningItem

Example

{
  "type": "reasoning",
  "id": "example",
  "encrypted_content": "example",
  "summary": [
    {
      "type": "summary_text",
      "text": "example"
    }
  ],
  "content": [
    {
      "type": "reasoning_text",
      "text": "example"
    }
  ],
  "status": "in_progress"
}

Compaction item

Type: CompactionSummaryItemParam

A compaction item generated by the v1/responses/compact API.
Example
```
{
  "id": "example",
  "type": "compaction",
  "encrypted_content": "example"
}
```

Image generation call

Type: ImageGenToolCall

An image generation request made by the model.

Example

{
  "type": "image_generation_call",
  "id": "example",
  "status": "in_progress",
  "result": "example"
}

Code interpreter tool call

Type: CodeInterpreterToolCall

A tool call to run code.

Example

{
  "type": "code_interpreter_call",
  "id": "example",
  "status": "in_progress",
  "container_id": "example",
  "code": "example",
  "outputs": [
    {
      "type": "logs",
      "logs": "example"
    }
  ]
}

Shell tool call

Type: FunctionShellCall

A tool call that executes one or more shell commands in a managed environment.

Example

{
  "type": "shell_call",
  "id": "example",
  "call_id": "example",
  "action": {
    "commands": [
      "example"
    ],
    "timeout_ms": 0,
    "max_output_length": 0
  },
  "status": "in_progress",
  "environment": {
    "type": "container_reference",
    "container_id": "example"
  },
  "created_by": "example"
}

Shell call output

Type: FunctionShellCallOutput

The output of a shell tool call that was emitted.

Example

{
  "type": "shell_call_output",
  "id": "example",
  "call_id": "example",
  "status": "in_progress",
  "output": [
    {
      "stdout": "example",
      "stderr": "example",
      "outcome": {
        "type": "timeout"
      },
      "created_by": "example"
    }
  ],
  "max_output_length": 0,
  "created_by": "example"
}

MCP list tools

Type: MCPListTools

A list of tools available on an MCP server.

Example

{
  "type": "mcp_list_tools",
  "id": "example",
  "server_label": "example",
  "tools": [
    {
      "name": "example",
      "description": "example",
      "input_schema": {},
      "annotations": {}
    }
  ],
  "error": "example"
}

MCP approval request

Type: MCPApprovalRequest

A request for human approval of a tool invocation.

Example

{
  "type": "mcp_approval_request",
  "id": "example",
  "server_label": "example",
  "name": "example",
  "arguments": "example"
}

MCP approval response

Type: MCPApprovalResponse

A response to an MCP approval request.

Example

{
  "type": "mcp_approval_response",
  "id": "example",
  "approval_request_id": "example",
  "approve": true,
  "reason": "example"
}

MCP tool call

Type: MCPToolCall

An invocation of a tool on an MCP server.

Example

{
  "type": "mcp_call",
  "id": "example",
  "server_label": "example",
  "name": "example",
  "arguments": "example",
  "output": "example",
  "error": "example",
  "status": "in_progress",
  "approval_request_id": "example"
}

Example

{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {
      "type": "input_text",
      "text": "example"
    }
  ]
}

ItemReferenceParam

An internal identifier for an item to reference.

Name

Description

Type: string

The ID of the item to reference.

Example: example

type

Type: string

The type of item to reference. Always item_reference.

Default: item_reference

Const: item_reference

Example

{
  "type": "item_reference",
  "id": "example"
}

InputItem

One of 2 types

Item

Type: Item

An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs.

Content item used to generate a response.
Example
```
{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {
      "type": "input_text",
      "text": "example"
    }
  ]
}
```
Item reference

Type: ItemReferenceParam

An internal identifier for an item to reference.
Example
```
{
  "type": "item_reference",
  "id": "example"
}
```

Example

{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {}
  ]
}

{
  "id": "example",
  "object": "conversation",
  "metadata": null,
  "created_at": 0
}

Name	Description
created_at	Type: integer The time at which the conversation was created, measured in seconds since the Unix epoch.
id	Type: string The unique ID of the conversation. Example: `example`
metadata	Type: unknown Set of 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. Example: `null`
object	Type: string The object type, which is always `conversation`. Default: `conversation` Const: `conversation`

InputImageContentParamAutoParam

An image input to the model.

Name	Description
type	Type: string The type of the input item. Always `input_image`. Default: `input_image` Const: `input_image`
detail	Type: DetailEnum The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`. Enum: `low`, `high`, `auto`, `original`
file_id	Type: string The ID of the file to be sent to the model. Example: `fvtdeb81rt1d978c5hvb`
image_url	Type: string The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL. Max length: `20971520` Example: `example`

Example

{
  "type": "input_image",
  "image_url": "example",
  "file_id": "fvtdeb81rt1d978c5hvb",
  "detail": "low"
}

InputFileContentParam

A file input to the model.

Name	Description
type	Type: string The type of the input item. Always `input_file`. Default: `input_file` Const: `input_file`
detail	Type: FileDetailEnum The detail level of the file to be sent to the model. Use `low` for the default rendering behavior, or `high` to render the file at higher quality. Defaults to `low`. Enum: `low`, `high`
file_data	Type: string The base64-encoded data of the file to be sent to the model. Max length: `73400320` Example: `example`
file_id	Type: string The ID of the file to be sent to the model. Example: `fvtdeb81rt1d978c5hvb`
file_url	Type: string The URL of the file to be sent to the model. Example: `example`
filename	Type: string The name of the file to be sent to the model. Example: `example`

Example

{
  "type": "input_file",
  "file_id": "fvtdeb81rt1d978c5hvb",
  "filename": "example",
  "file_data": "example",
  "file_url": "example",
  "detail": "low"
}

FunctionCallOutputItemParam

The output of a function tool call.

Name	Description
call_id	Type: string The unique ID of the function tool call generated by the model. Min length: `1` Max length: `64` Example: `example`
output	One of 2 types Type: string A JSON string of the output of the function tool call. Max length: `10485760` Example: `example` Type: array One of 3 types Input text Type: InputTextContentParam A text input to the model. Example `{ "type": "input_text", "text": "example" }` Input image Type: InputImageContentParamAutoParam An image input to the model. Example `{ "type": "input_image", "image_url": "example", "file_id": "fvtdeb81rt1d978c5hvb", "detail": "low" }` Input file Type: InputFileContentParam A file input to the model. Example `{ "type": "input_file", "file_id": "fvtdeb81rt1d978c5hvb", "filename": "example", "file_data": "example", "file_url": "example", "detail": "low" }` An array of content outputs (text, image, file) for the function tool call. Example `[ { "type": "input_text", "text": "example" } ]` Text, image, or file output of the function tool call. Example: `example`
type	Type: string The type of the function tool call output. Always `function_call_output`. Default: `function_call_output` Const: `function_call_output`
id	Type: string The unique ID of the function tool call output. Populated when this item is returned via API. Example: `example`
status	Type: FunctionCallItemStatus The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. Enum: `in_progress`, `completed`, `incomplete`

Example

{
  "id": "example",
  "call_id": "example",
  "type": "function_call_output",
  "output": "example",
  "status": "in_progress"
}

FunctionShellCall

A tool call that executes one or more shell commands in a managed environment.

Name	Description
action	Type: FunctionShellAction The shell commands and limits that describe how to run the tool call. Execute a shell command. Example `{ "commands": [ "example" ], "timeout_ms": 0, "max_output_length": 0 }`
call_id	Type: string The unique ID of the shell tool call generated by the model. Example: `example`
environment	Any of 2 types Container Reference Type: ContainerReferenceResource Represents a container created with /v1/containers. Example `{ "type": "container_reference", "container_id": "example" }` Type: null Example: `null` Example `{ "type": "container_reference", "container_id": "example" }`
id	Type: string The unique ID of the shell tool call. Populated when this item is returned via API. Example: `example`
status	Type: LocalShellCallStatus The status of the shell call. One of `in_progress`, `completed`, or `incomplete`. Enum: `in_progress`, `completed`, `incomplete`
type	Type: string The type of the item. Always `shell_call`. Default: `shell_call` Const: `shell_call`
created_by	Type: string The ID of the entity that created this tool call. Example: `example`

Example

{
  "type": "shell_call",
  "id": "example",
  "call_id": "example",
  "action": {
    "commands": [
      "example"
    ],
    "timeout_ms": 0,
    "max_output_length": 0
  },
  "status": "in_progress",
  "environment": {
    "type": "container_reference",
    "container_id": "example"
  },
  "created_by": "example"
}

FunctionShellCallOutput

The output of a shell tool call that was emitted.

Name	Description
call_id	Type: string The unique ID of the shell tool call generated by the model. Example: `example`
id	Type: string The unique ID of the shell call output. Populated when this item is returned via API. Example: `example`
max_output_length	Any of 2 types Type: integer The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output. Type: null Example: `null` Example: `0`
output	Type: FunctionShellCallOutputContent[] An array of shell call output contents Example `[ { "stdout": "example", "stderr": "example", "outcome": { "type": "timeout" }, "created_by": "example" } ]`
status	Type: LocalShellCallOutputStatusEnum The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. Enum: `in_progress`, `completed`, `incomplete`
type	Type: string The type of the shell call output. Always `shell_call_output`. Default: `shell_call_output` Const: `shell_call_output`
created_by	Type: string The identifier of the actor that created the item. Example: `example`

Example

{
  "type": "shell_call_output",
  "id": "example",
  "call_id": "example",
  "status": "in_progress",
  "output": [
    {
      "stdout": "example",
      "stderr": "example",
      "outcome": {
        "type": "timeout"
      },
      "created_by": "example"
    }
  ],
  "max_output_length": 0,
  "created_by": "example"
}

Item

Content item used to generate a response.

Type: object

One of 16 types

Input message

Type: InputMessage

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role.
Example
```
{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {
      "type": "input_text",
      "text": "example"
    }
  ]
}
```

Output message

Type: OutputMessage

An output message from the model.

Example

{
  "id": "example",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "output_text",
      "text": "example",
      "annotations": [
        null
      ],
      "logprobs": [
        {}
      ]
    }
  ],
  "phase": "commentary",
  "status": "in_progress"
}

File search tool call

Type: FileSearchToolCall

The results of a File Search tool call.

Example

{
  "id": "example",
  "type": "file_search_call",
  "status": "in_progress",
  "queries": [
    "example"
  ],
  "results": [
    {
      "file_id": "example",
      "text": "example",
      "filename": "example",
      "attributes": null,
      "score": 0.5
    }
  ]
}

Web search tool call

Type: WebSearchToolCall

The results of a web search tool call.

Example

{
  "id": "example",
  "type": "web_search_call",
  "status": "in_progress",
  "action": {
    "type": "search",
    "query": "example",
    "queries": [
      "example"
    ],
    "sources": [
      {
        "type": "url",
        "url": "example"
      }
    ]
  }
}

Function tool call

Type: FunctionToolCall

A tool call to run a function.

Example

{
  "id": "example",
  "type": "function_call",
  "call_id": "example",
  "namespace": "example",
  "name": "example",
  "arguments": "example",
  "status": "in_progress"
}

Function tool call output

Type: FunctionCallOutputItemParam

The output of a function tool call.

Example

{
  "id": "example",
  "call_id": "example",
  "type": "function_call_output",
  "output": "example",
  "status": "in_progress"
}

Reasoning

Type: ReasoningItem

Example

{
  "type": "reasoning",
  "id": "example",
  "encrypted_content": "example",
  "summary": [
    {
      "type": "summary_text",
      "text": "example"
    }
  ],
  "content": [
    {
      "type": "reasoning_text",
      "text": "example"
    }
  ],
  "status": "in_progress"
}

Compaction item

Type: CompactionSummaryItemParam

A compaction item generated by the v1/responses/compact API.
Example
```
{
  "id": "example",
  "type": "compaction",
  "encrypted_content": "example"
}
```

Image generation call

Type: ImageGenToolCall

An image generation request made by the model.

Example

{
  "type": "image_generation_call",
  "id": "example",
  "status": "in_progress",
  "result": "example"
}

Code interpreter tool call

Type: CodeInterpreterToolCall

A tool call to run code.

Example

{
  "type": "code_interpreter_call",
  "id": "example",
  "status": "in_progress",
  "container_id": "example",
  "code": "example",
  "outputs": [
    {
      "type": "logs",
      "logs": "example"
    }
  ]
}

Shell tool call

Type: FunctionShellCall

A tool call that executes one or more shell commands in a managed environment.

Example

{
  "type": "shell_call",
  "id": "example",
  "call_id": "example",
  "action": {
    "commands": [
      "example"
    ],
    "timeout_ms": 0,
    "max_output_length": 0
  },
  "status": "in_progress",
  "environment": {
    "type": "container_reference",
    "container_id": "example"
  },
  "created_by": "example"
}

Shell call output

Type: FunctionShellCallOutput

The output of a shell tool call that was emitted.

Example

{
  "type": "shell_call_output",
  "id": "example",
  "call_id": "example",
  "status": "in_progress",
  "output": [
    {
      "stdout": "example",
      "stderr": "example",
      "outcome": {
        "type": "timeout"
      },
      "created_by": "example"
    }
  ],
  "max_output_length": 0,
  "created_by": "example"
}

MCP list tools

Type: MCPListTools

A list of tools available on an MCP server.

Example

{
  "type": "mcp_list_tools",
  "id": "example",
  "server_label": "example",
  "tools": [
    {
      "name": "example",
      "description": "example",
      "input_schema": {},
      "annotations": {}
    }
  ],
  "error": "example"
}

MCP approval request

Type: MCPApprovalRequest

A request for human approval of a tool invocation.

Example

{
  "type": "mcp_approval_request",
  "id": "example",
  "server_label": "example",
  "name": "example",
  "arguments": "example"
}

MCP approval response

Type: MCPApprovalResponse

A response to an MCP approval request.

Example

{
  "type": "mcp_approval_response",
  "id": "example",
  "approval_request_id": "example",
  "approve": true,
  "reason": "example"
}

MCP tool call

Type: MCPToolCall

An invocation of a tool on an MCP server.

Example

{
  "type": "mcp_call",
  "id": "example",
  "server_label": "example",
  "name": "example",
  "arguments": "example",
  "output": "example",
  "error": "example",
  "status": "in_progress",
  "approval_request_id": "example"
}

Example

{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {
      "type": "input_text",
      "text": "example"
    }
  ]
}

InputItem

One of 2 types

Item

Type: Item

An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs.

Content item used to generate a response.
Example
```
{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {
      "type": "input_text",
      "text": "example"
    }
  ]
}
```
Item reference

Type: ItemReferenceParam

An internal identifier for an item to reference.
Example
```
{
  "type": "item_reference",
  "id": "example"
}
```

Example

{
  "type": "message",
  "role": "user",
  "status": "in_progress",
  "content": [
    {}
  ]
}

Create a conversation

RequestRequest

BodyBody

MetadataMetadata

InputTextContentInputTextContent

ImageDetailImageDetail

InputImageContentInputImageContent

FileInputDetailFileInputDetail

InputFileContentInputFileContent

InputContentInputContent

InputMessageContentListInputMessageContentList

InputMessageInputMessage

FileCitationBodyFileCitationBody

UrlCitationBodyUrlCitationBody

ContainerFileCitationBodyContainerFileCitationBody

FilePathFilePath

AnnotationAnnotation

TopLogProbTopLogProb

LogProbLogProb

OutputTextContentOutputTextContent

RefusalContentRefusalContent

OutputMessageContentOutputMessageContent

MessagePhaseMessagePhase

OutputMessageOutputMessage

VectorStoreFileAttributesVectorStoreFileAttributes

FileSearchToolCallFileSearchToolCall

WebSearchActionSearchWebSearchActionSearch

WebSearchActionOpenPageWebSearchActionOpenPage

WebSearchActionFindWebSearchActionFind

WebSearchToolCallWebSearchToolCall

FunctionToolCallFunctionToolCall

InputTextContentParamInputTextContentParam

InputImageContentParamAutoParamInputImageContentParamAutoParam

InputFileContentParamInputFileContentParam

FunctionCallItemStatusFunctionCallItemStatus

FunctionCallOutputItemParamFunctionCallOutputItemParam

SummaryTextContentSummaryTextContent

ReasoningTextContentReasoningTextContent

ReasoningItemReasoningItem

CompactionSummaryItemParamCompactionSummaryItemParam

ImageGenToolCallImageGenToolCall

CodeInterpreterOutputLogsCodeInterpreterOutputLogs

CodeInterpreterOutputImageCodeInterpreterOutputImage

CodeInterpreterToolCallCodeInterpreterToolCall

FunctionShellActionFunctionShellAction

ContainerReferenceResourceContainerReferenceResource

FunctionShellCallFunctionShellCall

FunctionShellCallOutputTimeoutOutcomeFunctionShellCallOutputTimeoutOutcome

FunctionShellCallOutputExitOutcomeFunctionShellCallOutputExitOutcome

FunctionShellCallOutputContentFunctionShellCallOutputContent

FunctionShellCallOutputFunctionShellCallOutput

MCPListToolsToolMCPListToolsTool

MCPListToolsMCPListTools

MCPApprovalRequestMCPApprovalRequest

MCPApprovalResponseMCPApprovalResponse

MCPToolCallStatusMCPToolCallStatus

MCPToolCallMCPToolCall

ItemItem

ItemReferenceParamItemReferenceParam

InputItemInputItem

ResponsesResponses

200 OK200 OK

BodyBody

InputImageContentParamAutoParamInputImageContentParamAutoParam

InputFileContentParamInputFileContentParam

FunctionCallOutputItemParamFunctionCallOutputItemParam

FunctionShellCallFunctionShellCall

FunctionShellCallOutputFunctionShellCallOutput

ItemItem

InputItemInputItem

Была ли статья полезна?

Request

Body

Metadata

InputTextContent

ImageDetail

InputImageContent

FileInputDetail

InputFileContent

InputContent

InputMessageContentList

InputMessage

FileCitationBody

UrlCitationBody

ContainerFileCitationBody

FilePath

Annotation

TopLogProb

LogProb

OutputTextContent

RefusalContent

OutputMessageContent

MessagePhase

OutputMessage

VectorStoreFileAttributes

FileSearchToolCall

WebSearchActionSearch

WebSearchActionOpenPage

WebSearchActionFind

WebSearchToolCall

FunctionToolCall

InputTextContentParam

InputImageContentParamAutoParam

InputFileContentParam

FunctionCallItemStatus

FunctionCallOutputItemParam

SummaryTextContent

ReasoningTextContent

ReasoningItem

CompactionSummaryItemParam

ImageGenToolCall

CodeInterpreterOutputLogs

CodeInterpreterOutputImage

CodeInterpreterToolCall

FunctionShellAction

ContainerReferenceResource

FunctionShellCall

FunctionShellCallOutputTimeoutOutcome

FunctionShellCallOutputExitOutcome

FunctionShellCallOutputContent

FunctionShellCallOutput

MCPListToolsTool

MCPListTools

MCPApprovalRequest

MCPApprovalResponse

MCPToolCallStatus

MCPToolCall

Item

ItemReferenceParam

InputItem

Responses

200 OK

Body

InputImageContentParamAutoParam

InputFileContentParam

FunctionCallOutputItemParam

FunctionShellCall

FunctionShellCallOutput

Item

InputItem