Skip to main content
GET
/
agents
List agents
curl --request GET \
  --url https://api.trymaitai.ai/api/v1/agents \
  --header 'X-Maitai-Api-Key: <api-key>'
{
  "data": [
    {
      "id": 101,
      "agent_name": "Onboarding Agent",
      "application_id": 42,
      "status": "ENABLED",
      "description": "Guides new users through account setup"
    }
  ]
}

Authorizations

X-Maitai-Api-Key
string
header
required

Your Maitai API key from the Portal.

Query Parameters

include_subagents
boolean
default:true

Include sub-agents in the response.

include_actions
boolean
default:false

Include agent actions in the response.

Response

200 - application/json

List agents.

data
object[]