Get Agent Types

GET

/agenttype/all

Agent APIs

Retrieve a list of all agent types or filter by a specific agent type ID. If the agentType_id query parameter is provided, the response will return details for the specified agent type. Otherwise, all available agent types will be returned.

Response Example

{
    "success": true,
    "message": "status code 200: Agent Type Data fetched successfully",
    "data": [
        {
            "id": 1,
            "created_by": "System",
            "created_on": "2024-08-23T21:38:47.044052Z",
            "modified_by": "",
            "modified_on": "2024-08-23T21:38:47.044079Z",
            "name": "testAgent",
            "description": "i am testing"
        }
    ]
}

Request

Query Params

agentType_id

integer

optional

Optional. ID of a specific agent type to retrieve. If not provided, the API will return all agent types.

Responses

🟢200OK

application/json

Successfully fetched the agent type(s)

Body

success

boolean

optional

Example:

true

message

string

optional

Example:

status code 200: Agent Type Data fetched successfully

data

array [object {7}]

optional

integer

optional

Example:

created_by

string

optional

Example:

System

created_on

string <date-time>

optional

Example:

2024-08-23T21:38:47.044052Z

modified_by

string | null

optional

Example:

modified_on

string <date-time> | null

optional

Example:

2024-08-23T21:38:47.044079Z

name

string

optional

Example:

testAgent

description

string | null

optional

Example:

i am testing

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Get All Agents by Project

Update Agent Type