REST: List items
List all items for a conversation with the given ID.
HTTP request
GET https://ai.api.cloud.yandex.net/v1/conversations/{conversation_id}/items
Path parameters
|
Field |
Description |
|
conversation_id |
string Required field. The ID of the conversation to list items for. |
Query parameters
|
Field |
Description |
|
limit |
integer A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
|
order |
enum The order to return the input items in. Default is
|
|
after |
string An item ID to list items after, used in pagination. |
|
include[] |
enum [CURRENTLY NOT SUPPORTED] Specify additional output data to include in the model response. Currently supported values are: - [CURRENTLY NOT SUPPORTED]
|
Response
HTTP Code: 200
OK
Response schema: application/json
{
"object": "list",
"data": [
{
"<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"
}
]
}
],
"has_more": "boolean",
"first_id": "string",
"last_id": "string"
}
A list of Conversation items.
|
Field |
Description |
|
object |
list (const) Required field. The type of object returned, must be |
|
data[] |
unknown Required field. A single item within a conversation. The set of possible types are the same as the |
|
has_more |
boolean Required field. Whether there are more items available. |
|
first_id |
string Required field. The ID of the first item in the list. |
|
last_id |
string Required field. The ID of the last item in the list. |