AgentListResponse

AgentListResponse
AgentListResponse

List of agents.

Note, while this is based on OpenAI's Assistant API, the terms assistant and agent are not identical.

ref: https://platform.openai.com/docs/api-reference/assistants/listAssistants

JSON Example
{
    "object": "string",
    "has_more": false,
    "num_objects": 0,
    "data": [
        {
            "name": "string",
            "description": "string",
            "instructions": "string",
            "session_max_ttl": 0,
            "completion_role": "string",
            "index_id": "string",
            "index_top_n": 0,
            "index_similarity_cutoff": "number",
            "index_reference_format": "string",
            "index_reference_delimiter": "string",
            "session_max_length": 0,
            "session_summarization_strategy": "string",
            "metadata": {
                "metadata": "string"
            },
            "id": "string",
            "object": "string",
            "created_at": 0,
            "model": "string",
            "status": "string",
            "status_errors": [
                "string"
            ],
            "chat_system_instruction_mode": "string"
        }
    ],
    "first_id": "string",
    "last_id": "string"
}
string
object
Optional
Constraints: default: list

Object type, which is always list.

boolean
has_more
Optional

True, if the server may have more objects than returned in the response.

integer
num_objects
Required

Total number of objects that match the request. Note that this field is populated only if requested by the user (see set_num_objects request parameter).

array of Agent
data
Required

List of agents.

string As uuid As uuid
first_id
Required

ID of the first element in the list (if any)

string As uuid As uuid
last_id
Required

ID of the last element in the list (if any)

Returned By