Get All Agents

GET 
/api/agents

This endpoint retrieves all agents available to the user. The request must include a valid API key and user ID.

Request

Header Parameters

x-api-key stringrequired

API key to authorize the request.

userId stringrequired

ID of the user making the request.

Responses

200

Successfully retrieved all agents.

application/json

Schema

Schema

data

object[]

Array [

active boolean

Indicates if the agent is active.

agentid string

Unique identifier for the agent.

agenttype string

Type of the agent (e.g., "standard").

createdat date-time

Timestamp when the agent was created.

description string

Detailed description of what the agent does.

displayprompt string

User-facing prompt template with parameter placeholders.

goal string

The primary goal of the agent.

inputparameters object

Parameters that can be passed to the agent.

lastused date-timenullable

Timestamp when the agent was last used.

rootAgentName string

The name of the agent.

stepsBreakdown

object[]

Array [

agentname string

Name of the agent handling this step.

content

object

query string

Instructions for this step.

response stringnullable

Response from this step.

external string

External source used for this step.

type string

Type of step (rag, compile, or structure).

prompt string

Detailed instructions for this step (for structure steps).

]

]

Example (from schema)

{
  "data": [
    {
      "active": true,
      "agentid": "string",
      "agenttype": "string",
      "createdat": "2025-04-25T15:31:48.719Z",
      "description": "string",
      "displayprompt": "string",
      "goal": "string",
      "inputparameters": {},
      "lastused": "2025-04-25T15:31:48.719Z",
      "rootAgentName": "string",
      "stepsBreakdown": [
        {
          "agentname": "string",
          "content": {
            "query": "string",
            "response": "string"
          },
          "external": "string",
          "type": "string",
          "prompt": "string"
        }
      ]
    }
  ]
}

400

Error with fetch operation.

application/json

Schema

Schema

error string

Error message indicating the issue with the fetch operation.

Example (from schema)

{
  "error": "string"
}

403

Invalid API key or authentication failed.

application/json

Schema

Schema

error

object

message string

Detailed error message indicating authentication failure.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

405

Method not allowed.

application/json

Schema

Schema

error

object

message string

Error message indicating that the method is not allowed.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

500

Internal server error.

application/json

Schema

Schema

error

object

message string

Error message indicating an internal server error.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

Loading...