List Agents

List Agents

This method allows you to list all agents that have been configured.

Request
URI
GET
https://{api_host}/api/v1/compatibility/openai/v1/agents
COPY
Query Parameters
string
after
Optional

after

string
before
Optional

before

integer
limit
Optional
Constraints: exclusiveMinimum: 0 exclusiveMaximum: 1000 default: 100

limit

integer
offset
Optional
Constraints: minimum: 0 maximum: 4294967296 default: 0

offset

string
order
Optional
Constraints: default: asc

order

Possible values are : asc, desc,
boolean
set_num_objects
Optional
Constraints: default: false

set_num_objects

string
name
Optional

name

string
index_id
Optional

index_id

string
knowledge_base_id
Optional

knowledge_base_id

Authentication
This operation uses the following authentication methods.
Responses
200

Successful Response

Returns AgentListResponse of type(s) application/json 
{
    "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 object
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)


410

An invalid ID was passed for paginating results.

Operation doesn't return any data structure

422

Validation Error

Returns HTTPValidationError of type(s) application/json 
"HTTPValidationError Object"
array of object
detail
Optional

detail


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/compatibility/openai/v1/agents
On This Page
Agents Operations
GET
List Agents
POST
Create Agent
GET
List Assistants
POST
Create Assistant
GET
Get Agent
POST
Update Agent
DELETE
Delete Agent
GET
Get Assistant
POST
Update Assistant
DELETE
Delete Assistant
POST
Create Agent Chat Completion
POST
Create Assistant Chat Completion
POST
Create Agent Completion
POST
Create Assistant Completion