Skip to main content
GET
/
v1
/
active_agents
List active agents
curl --request GET \
  --url https://api.osvi.ai/v1/active_agents \
  --header 'API-Token: <api-key>'
[
  {
    "agent_id": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
    "name": "Appointment Reminder",
    "status": "active"
  },
  {
    "agent_id": "agent_x9KpL2Mn_41Tg83YWQNca-B_pe",
    "name": "Support Line",
    "status": "active"
  }
]

Authorizations

​
API-Token
string
header
required

16-character API token associated with your OSVI account. Find it in your dashboard under Settings → API.

Response

Array of active agents. Returns [] when no agents are active. Note: unlike other v1 endpoints, the response is a bare array without a success/data wrapper.

​
agent_id
string

The agent's unique identifier — the value to pass as agent_uuid elsewhere in the API.

Example:

"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og"

​
name
string

The agent's display name from the dashboard.

Example:

"Appointment Reminder"

​
status
enum<string>

Always active — inactive and archived agents are excluded from this endpoint.

Available options:
active
Example:

"active"