Get agent

GET

/api/v1/agents/{id}

const url = 'https://example.com/api/v1/agents/example?includeDeleted=true';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/agents/example?includeDeleted=true'

Parameters

Path Parameters

required

string

Query Parameters

includeDeleted

string

Allowed values: true false

Responses

200

Success

application/json

object

_id

required

string

name

required

string

description

string

modelProvider

string

supportedModels

required

Array<string>

defaultModel

string

available

boolean

capabilities

object

supportsReasoningEffort

boolean

supportsMcpServers

boolean

supportsSkills

boolean

supportsExtensions

boolean

versions

Array<object>

object

agentVersion

required

string

>= 1 characters

workerVersion

required

string

>= 1 characters

components

required

object

key

additional properties

string

gitCommit

required

string

>= 1 characters

buildTime

required

string

>= 1 characters

imageTag

required

string

>= 1 characters

queueName

string

status

required

string

Allowed values: active retired

createdAt

required

string | null format: date-time

createdAt

required

string | null format: date-time

updatedAt

string | null format: date-time

deletedAt

string | null format: date-time

Example

{
  "versions": [
    {
      "status": "active"
    }
  ]
}

404

Agent not found