REST: Retrieve an item

Статья создана

Обновлена 24 декабря 2025 г.

HTTP request
Path parameters
Query parameters
Response
0Item
WebSearchActionSearch
SourcesItem
WebSearchActionOpenPage
WebSearchActionFind
ClickParam
DoubleClickAction
Drag
DragPoint
KeyPressAction
Move
Screenshot
Scroll
Type
Wait
ComputerCallSafetyCheckParam
Summary
ReasoningTextContent
LocalShellExecAction
FunctionShellAction
FunctionShellCallOutputContent
FunctionShellCallOutputTimeoutOutcome
FunctionShellCallOutputExitOutcome
ApplyPatchCreateFileOperation
ApplyPatchDeleteFileOperation
ApplyPatchUpdateFileOperation
MCPListToolsTool

[CURRENTLY NOT SUPPORTED]

HTTP request

GET https://ai.api.cloud.yandex.net/v1/conversations/{conversation_id}/items/{item_id}

Path parameters

Field

Description

conversation_id

string

Required field. The ID of the conversation that contains the item.

item_id

string

Required field. The ID of the item to retrieve.

Query parameters

Field

Description

include[]

enum

Additional fields to include in the response.

Specify additional output data to include in the model response. Currently supported values are:

web_search_call.action.sources: Include the sources of the web search tool call.
code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.
computer_call_output.output.image_url: Include image urls from the computer call output.
file_search_call.results: Include the search results of the file search tool call.
message.input_image.image_url: Include image urls from the input message.
message.output_text.logprobs: Include logprobs with assistant messages.
reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).'
file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs

Response

HTTP Code: 200

Response schema: application/json

{
  "<anyOf>": [
    {
      "type": "string",
      "id": "string",
      "status": "string",
      "role": "string",
      "content": [
        {
          "<anyOf>": [
            {
              "type": "string",
              "text": "string"
            },
            {
              "type": "string",
              "text": "string",
              "annotations": [
                {
                  "<anyOf>": [
                    {
                      "type": "string",
                      "file_id": "string",
                      "index": "integer",
                      "filename": "string"
                    },
                    {
                      "type": "string",
                      "url": "string",
                      "start_index": "integer",
                      "end_index": "integer",
                      "title": "string"
                    },
                    {
                      "type": "string",
                      "container_id": "string",
                      "file_id": "string",
                      "start_index": "integer",
                      "end_index": "integer",
                      "filename": "string"
                    },
                    {
                      "type": "string",
                      "file_id": "string",
                      "index": "integer"
                    }
                  ]
                }
              ],
              "logprobs": [
                {
                  "token": "string",
                  "logprob": "number",
                  "bytes": [
                    "integer"
                  ],
                  "top_logprobs": [
                    {
                      "token": "string",
                      "logprob": "number",
                      "bytes": [
                        "integer"
                      ]
                    }
                  ]
                }
              ]
            },
            {
              "type": "string",
              "text": "string"
            },
            {
              "type": "string",
              "text": "string"
            },
            {
              "type": "string",
              "text": "string"
            },
            {
              "type": "string",
              "refusal": "string"
            },
            {
              "type": "string",
              "image_url": "unknown",
              "file_id": "unknown",
              "detail": "string"
            },
            {
              "type": "string",
              "image_url": "unknown",
              "file_id": "unknown"
            },
            {
              "type": "string",
              "file_id": "unknown",
              "filename": "string",
              "file_url": "string",
              "file_data": "string"
            }
          ]
        }
      ]
    },
    "unknown",
    "unknown",
    {
      "id": "string",
      "type": "string",
      "status": "string",
      "queries": [
        "string"
      ],
      "results": "unknown"
    },
    {
      "id": "string",
      "type": "string",
      "status": "string",
      "action": {
        "<anyOf>": [
          {
            "type": "string",
            "query": "string",
            "sources": [
              {
                "type": "string",
                "url": "string"
              }
            ]
          },
          {
            "type": "string",
            "url": "string"
          },
          {
            "type": "string",
            "url": "string",
            "pattern": "string"
          }
        ]
      }
    },
    {
      "type": "string",
      "id": "string",
      "status": "string",
      "result": "unknown"
    },
    {
      "type": "string",
      "id": "string",
      "call_id": "string",
      "action": "unknown",
      "pending_safety_checks": [
        {
          "id": "string",
          "code": "unknown",
          "message": "unknown"
        }
      ],
      "status": "string"
    },
    "unknown",
    {
      "type": "string",
      "id": "string",
      "encrypted_content": "unknown",
      "summary": [
        {
          "type": "string",
          "text": "string"
        }
      ],
      "content": [
        {
          "type": "string",
          "text": "string"
        }
      ],
      "status": "string"
    },
    {
      "type": "string",
      "id": "string",
      "status": "string",
      "container_id": "string",
      "code": "unknown",
      "outputs": "unknown"
    },
    {
      "type": "string",
      "id": "string",
      "call_id": "string",
      "action": {
        "type": "string",
        "command": [
          "string"
        ],
        "timeout_ms": "unknown",
        "working_directory": "unknown",
        "env": {
          "string": "string"
        },
        "user": "unknown"
      },
      "status": "string"
    },
    {
      "type": "string",
      "id": "string",
      "output": "string",
      "status": "unknown"
    },
    {
      "type": "string",
      "id": "string",
      "call_id": "string",
      "action": {
        "commands": [
          "string"
        ],
        "timeout_ms": "unknown",
        "max_output_length": "unknown"
      },
      "status": "string",
      "created_by": "string"
    },
    {
      "type": "string",
      "id": "string",
      "call_id": "string",
      "output": [
        {
          "stdout": "string",
          "stderr": "string",
          "outcome": "unknown",
          "created_by": "string"
        }
      ],
      "max_output_length": "unknown",
      "created_by": "string"
    },
    {
      "type": "string",
      "id": "string",
      "call_id": "string",
      "status": "string",
      "operation": "unknown",
      "created_by": "string"
    },
    {
      "type": "string",
      "id": "string",
      "call_id": "string",
      "status": "string",
      "output": "unknown",
      "created_by": "string"
    },
    {
      "type": "string",
      "id": "string",
      "server_label": "string",
      "tools": [
        {
          "name": "string",
          "description": "unknown",
          "input_schema": {},
          "annotations": "unknown"
        }
      ],
      "error": "unknown"
    },
    {
      "type": "string",
      "id": "string",
      "server_label": "string",
      "name": "string",
      "arguments": "string"
    },
    {
      "type": "string",
      "id": "string",
      "approval_request_id": "string",
      "approve": "boolean",
      "reason": "unknown"
    },
    {
      "type": "string",
      "id": "string",
      "server_label": "string",
      "name": "string",
      "arguments": "string",
      "output": "unknown",
      "error": "unknown",
      "status": "string",
      "approval_request_id": "unknown"
    },
    {
      "type": "string",
      "id": "string",
      "call_id": "string",
      "name": "string",
      "input": "string"
    },
    {
      "type": "string",
      "id": "string",
      "call_id": "string",
      "output": "unknown"
    }
  ]
}

Any of:

A message to or from the model.

Field	Description
type	enum Required field. The type of the message. Always set to `message`. `message`
id	string Required field. The unique ID of the message.
status	enum Required field. `in_progress` `completed` `incomplete`
role	enum Required field. `unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`
content[]	unknown Required field.

Field	Description
Empty

Field	Description
Empty

The results of a file search tool call.

Field	Description
id	string Required field. The unique ID of the file search tool call.
type	enum Required field. The type of the file search tool call. Always `file_search_call`. `file_search_call`
status	enum Required field. The status of the file search tool call. One of `in_progress`, `searching`, `incomplete` or `failed`, `in_progress` `searching` `completed` `incomplete` `failed`
queries[]	string Required field.
results	Any of 0Item \| null

The results of a web search tool call.

Field	Description
id	string Required field. The unique ID of the web search tool call.
type	enum Required field. The type of the web search tool call. Always `web_search_call`. `web_search_call`
status	enum Required field. The status of the web search tool call. `in_progress` `searching` `completed` `failed`
action	Any of WebSearchActionSearch \| WebSearchActionOpenPage \| WebSearchActionFind

An image generation request made by the model.

Field	Description
type	enum Required field. The type of the image generation call. Always `image_generation_call`. `image_generation_call`
id	string Required field. The unique ID of the image generation call.
status	enum Required field. The status of the image generation call. `in_progress` `completed` `generating` `failed`
result	Any of string \| null

CURRENTLY NOT SUPPORTED

Field	Description
type	enum Required field. The type of the computer call. Always `computer_call`. `computer_call`
id	string Required field. The unique ID of the computer call.
call_id	string Required field. An identifier used when responding to the tool call with output.
action	Any of ClickParam \| DoubleClickAction \| Drag \| KeyPressAction \| Move \| Screenshot \| Scroll \| Type \| Wait
pending_safety_checks[]	ComputerCallSafetyCheckParam Required field. A pending safety check for the computer call.
status	enum Required field. The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. `in_progress` `completed` `incomplete`

Field	Description
Empty

A description of the chain of thought used by a reasoning model while generating a response. '

Field	Description
type	enum Required field. The type of the object. Always `reasoning`. `reasoning`
id	string Required field. The unique identifier of the reasoning content.
encrypted_content	Any of string \| null
summary[]	Summary Required field. A summary text from the model.
content[]	ReasoningTextContent Required field. Reasoning text from the model.
status	enum The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. `in_progress` `completed` `incomplete`

A tool call to run code.

Field	Description
type	enum Required field. The type of the code interpreter tool call. Always `code_interpreter_call`. `code_interpreter_call`
id	string Required field. The unique ID of the code interpreter tool call.
status	enum Required field. The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`. `in_progress` `completed` `incomplete` `interpreting` `failed`
container_id	string Required field. The ID of the container used to run the code.
code	Any of string \| null
outputs	Any of unknown \| null

A tool call to run a command on the local shell.

Field	Description
type	enum Required field. The type of the local shell call. Always `local_shell_call`. `local_shell_call`
id	string Required field. The unique ID of the local shell call.
call_id	string Required field. The unique ID of the local shell tool call generated by the model.
action	LocalShellExecAction Required field. Execute a shell command on the server.
status	enum Required field. The status of the local shell call. `in_progress` `completed` `incomplete`

The output of a local shell tool call.

Field	Description
type	enum Required field. The type of the local shell tool call output. Always `local_shell_call_output`. `local_shell_call_output`
id	string Required field. The unique ID of the local shell tool call generated by the model.
output	string Required field. A JSON string of the output of the local shell tool call.
status	Any of enum \| null

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

Field	Description
type	enum Required field. The type of the item. Always `shell_call`. `shell_call`
id	string Required field. The unique ID of the shell tool call. Populated when this item is returned via API.
call_id	string Required field. The unique ID of the shell tool call generated by the model.
action	FunctionShellAction Required field. Execute a shell command.
status	enum Required field. `in_progress` `completed` `incomplete`
created_by	string The ID of the entity that created this tool call.

The output of a shell tool call.

Field	Description
type	enum Required field. The type of the shell call output. Always `shell_call_output`. `shell_call_output`
id	string Required field. The unique ID of the shell call output. Populated when this item is returned via API.
call_id	string Required field. The unique ID of the shell tool call generated by the model.
output[]	FunctionShellCallOutputContent Required field. The content of a shell call output.
max_output_length	Any of integer \| null
created_by	string

A tool call that applies file diffs by creating, deleting, or updating files.

Field	Description
type	enum Required field. The type of the item. Always `apply_patch_call`. `apply_patch_call`
id	string Required field. The unique ID of the apply patch tool call. Populated when this item is returned via API.
call_id	string Required field. The unique ID of the apply patch tool call generated by the model.
status	enum Required field. `in_progress` `completed`
operation	Any of ApplyPatchCreateFileOperation \| ApplyPatchDeleteFileOperation \| ApplyPatchUpdateFileOperation
created_by	string The ID of the entity that created this tool call.

The output emitted by an apply patch tool call.

Field	Description
type	enum Required field. The type of the item. Always `apply_patch_call_output`. `apply_patch_call_output`
id	string Required field. The unique ID of the apply patch tool call output. Populated when this item is returned via API.
call_id	string Required field. The unique ID of the apply patch tool call generated by the model.
status	enum Required field. `completed` `failed`
output	Any of string \| null
created_by	string The ID of the entity that created this tool call output.

A list of tools available on an MCP server.

Field	Description
type	enum Required field. The type of the item. Always `mcp_list_tools`. `mcp_list_tools`
id	string Required field. The unique ID of the list.
server_label	string Required field. The label of the MCP server.
tools[]	MCPListToolsTool Required field. A tool available on an MCP server.
error	Any of string \| null

A request for human approval of a tool invocation.

Field	Description
type	enum Required field. The type of the item. Always `mcp_approval_request`. `mcp_approval_request`
id	string Required field. The unique ID of the approval request.
server_label	string Required field. The label of the MCP server making the request.
name	string Required field. The name of the tool to run.
arguments	string Required field. A JSON string of arguments for the tool.

A response to an MCP approval request.

Field	Description
type	enum Required field. The type of the item. Always `mcp_approval_response`. `mcp_approval_response`
id	string Required field. The unique ID of the approval response
approval_request_id	string Required field. The ID of the approval request being answered.
approve	boolean Required field. Whether the request was approved.
reason	Any of string \| null

An invocation of a tool on an MCP server.

Field	Description
type	enum Required field. The type of the item. Always `mcp_call`. `mcp_call`
id	string Required field. The unique ID of the tool call.
server_label	string Required field. The label of the MCP server running the tool.
name	string Required field. The name of the tool that was run.
arguments	string Required field. A JSON string of the arguments passed to the tool.
output	Any of string \| null
error	Any of string \| null
status	enum `in_progress` `completed` `incomplete` `calling` `failed`
approval_request_id	Any of string \| null

A call to a custom tool created by the model.

Field	Description
type	enum Required field. The type of the custom tool call. Always `custom_tool_call`. `custom_tool_call`
id	string The unique ID of the custom tool call in the Yandex Cloud AI Studio platform.
call_id	string Required field. An identifier used to map this custom tool call to a tool call output.
name	string Required field. The name of the custom tool being called.
input	string Required field. The input for the custom tool call generated by the model.

The output of a custom tool call from your code, being sent back to the model.

Field	Description
type	enum Required field. The type of the custom tool call output. Always `custom_tool_call_output`. `custom_tool_call_output`
id	string The unique ID of the custom tool call output in the Yandex Cloud AI Studio platform.
call_id	string Required field. The call ID, used to map this custom tool call output to a custom tool call.
output	Any of string \| unknown

0Item

Field	Description
file_id	string The unique ID of the file.
text	string The text that was retrieved from the file.
filename	string The name of the file.
attributes	Any of object (map<string, string>) \| null
score	number (float) The relevance score of the file - a value between 0 and 1.

WebSearchActionSearch

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

Field	Description
type	enum Required field. The action type. `search`
query	string Required field. The search query.
sources[]	SourcesItem Required field. A source used in the search.

SourcesItem

A source used in the search.

Field

Description

type

enum

Required field. The type of source. Always url.

url

url

string

Required field. The URL of the source.

WebSearchActionOpenPage

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

Field

Description

type

enum

Required field. The action type.

open_page

url

string (uri)

Required field. The URL opened by the model.

WebSearchActionFind

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

Field	Description
type	enum Required field. The action type. `find`
url	string (uri) Required field. The URL of the page searched for the pattern.
pattern	string Required field. The pattern or text to search for within the page.

ClickParam

A click action.

Field	Description
type	enum Required field. Specifies the event type. For a click action, this property is always `click`. `click`
button	enum Required field. `left` `right` `wheel` `back` `forward`
x	integer Required field. The x-coordinate where the click occurred.
y	integer Required field. The y-coordinate where the click occurred.

DoubleClickAction

A double click action.

Field	Description
type	enum Required field. Specifies the event type. For a double click action, this property is always set to `double_click`. `double_click`
x	integer Required field. The x-coordinate where the double click occurred.
y	integer Required field. The y-coordinate where the double click occurred.

Drag

A drag action.

Field

Description

type

enum

Required field. Specifies the event type. For a drag action, this property is
always set to drag.

drag

path[]

DragPoint

Required field. An x/y coordinate pair, e.g. { x: 100, y: 200 }.

DragPoint

An x/y coordinate pair, e.g. { x: 100, y: 200 }.

Field

Description

integer

Required field. The x-coordinate.

integer

Required field. The y-coordinate.

KeyPressAction

A collection of keypresses the model would like to perform.

Field

Description

type

enum

Required field. Specifies the event type. For a keypress action, this property is always set to keypress.

keypress

keys[]

string

Required field. One of the keys the model is requesting to be pressed.

Move

A mouse move action.

Field	Description
type	enum Required field. Specifies the event type. For a move action, this property is always set to `move`. `move`
x	integer Required field. The x-coordinate to move to.
y	integer Required field. The y-coordinate to move to.

Screenshot

A screenshot action.

Field

Description

type

enum

Required field. Specifies the event type. For a screenshot action, this property is
always set to screenshot.

screenshot

Scroll

A scroll action.

Field	Description
type	enum Required field. Specifies the event type. For a scroll action, this property is always set to `scroll`. `scroll`
x	integer Required field. The x-coordinate where the scroll occurred.
y	integer Required field. The y-coordinate where the scroll occurred.
scroll_x	integer Required field. The horizontal scroll distance.
scroll_y	integer Required field. The vertical scroll distance.

Type

An action to type in text.

Field

Description

type

enum

Required field. Specifies the event type. For a type action, this property is
always set to type.

type

text

string

Required field. The text to type.

Wait

A wait action.

Field

Description

type

enum

Required field. Specifies the event type. For a wait action, this property is
always set to wait.

wait

ComputerCallSafetyCheckParam

A pending safety check for the computer call.

Field	Description
id	string Required field. The ID of the pending safety check.
code	Any of string \| null
message	Any of string \| null

Summary

A summary text from the model.

Field

Description

type

enum

Required field. The type of the object. Always summary_text.

summary_text

text

string

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

ReasoningTextContent

Reasoning text from the model.

Field

Description

type

enum

Required field. The type of the reasoning text. Always reasoning_text.

reasoning_text

text

string

Required field. The reasoning text from the model.

LocalShellExecAction

Execute a shell command on the server.

Field	Description
type	enum Required field. The type of the local shell action. Always `exec`. `exec`
command[]	string Required field.
timeout_ms	Any of integer \| null
working_directory	Any of string \| null
env	object (map<string, string>) Required field.
user	Any of string \| null

FunctionShellAction

Execute a shell command.

Field	Description
commands[]	string Required field. A list of commands to run.
timeout_ms	Any of integer \| null
max_output_length	Any of integer \| null

FunctionShellCallOutputContent

The content of a shell call output.

Field	Description
stdout	string Required field.
stderr	string Required field.
outcome	Any of FunctionShellCallOutputTimeoutOutcome \| FunctionShellCallOutputExitOutcome
created_by	string

FunctionShellCallOutputTimeoutOutcome

Indicates that the shell call exceeded its configured time limit.

Field

Description

type

enum

Required field. The outcome type. Always timeout.

timeout

FunctionShellCallOutputExitOutcome

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

Field

Description

type

enum

Required field. The outcome type. Always exit.

exit

exit_code

integer

Required field. Exit code from the shell process.

ApplyPatchCreateFileOperation

Instruction describing how to create a file via the apply_patch tool.

Field	Description
type	enum Required field. Create a new file with the provided diff. `create_file`
path	string Required field. Path of the file to create.
diff	string Required field. Diff to apply.

ApplyPatchDeleteFileOperation

Instruction describing how to delete a file via the apply_patch tool.

Field

Description

type

enum

Required field. Delete the specified file.

delete_file

path

string

Required field. Path of the file to delete.

ApplyPatchUpdateFileOperation

Instruction describing how to update a file via the apply_patch tool.

Field	Description
type	enum Required field. Update an existing file with the provided diff. `update_file`
path	string Required field. Path of the file to update.
diff	string Required field. Diff to apply.

MCPListToolsTool

A tool available on an MCP server.

Field	Description
name	string Required field. The name of the tool.
description	Any of string \| null
input_schema	InputSchema Required field. The JSON schema describing the tool''s input.
annotations	Any of Annotations0 \| null

REST: Retrieve an item

HTTP requestHTTP request

Path parametersPath parameters

Query parametersQuery parameters

ResponseResponse

0Item0Item

WebSearchActionSearchWebSearchActionSearch

SourcesItemSourcesItem

WebSearchActionOpenPageWebSearchActionOpenPage

WebSearchActionFindWebSearchActionFind

ClickParamClickParam

DoubleClickActionDoubleClickAction

DragDrag

DragPointDragPoint

KeyPressActionKeyPressAction

MoveMove

ScreenshotScreenshot

ScrollScroll

TypeType

WaitWait

ComputerCallSafetyCheckParamComputerCallSafetyCheckParam

SummarySummary

ReasoningTextContentReasoningTextContent

LocalShellExecActionLocalShellExecAction

FunctionShellActionFunctionShellAction

FunctionShellCallOutputContentFunctionShellCallOutputContent

FunctionShellCallOutputTimeoutOutcomeFunctionShellCallOutputTimeoutOutcome

FunctionShellCallOutputExitOutcomeFunctionShellCallOutputExitOutcome

ApplyPatchCreateFileOperationApplyPatchCreateFileOperation

ApplyPatchDeleteFileOperationApplyPatchDeleteFileOperation

ApplyPatchUpdateFileOperationApplyPatchUpdateFileOperation

MCPListToolsToolMCPListToolsTool

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

HTTP request

Path parameters

Query parameters

Response

0Item

WebSearchActionSearch

SourcesItem

WebSearchActionOpenPage

WebSearchActionFind

ClickParam

DoubleClickAction

Drag

DragPoint

KeyPressAction

Move

Screenshot

Scroll

Type

Wait

ComputerCallSafetyCheckParam

Summary

ReasoningTextContent

LocalShellExecAction

FunctionShellAction

FunctionShellCallOutputContent

FunctionShellCallOutputTimeoutOutcome

FunctionShellCallOutputExitOutcome

ApplyPatchCreateFileOperation

ApplyPatchDeleteFileOperation

ApplyPatchUpdateFileOperation

MCPListToolsTool