get
https://api.superwise.ai/v1/agents/
Get an agent by id.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Returns one agent by its ID, including its name, status, url, dataset_id, observability setting, tags, and guardrail violation message.
When to use it
Use it to read an agent's current settings or check its status, which is one of healthy, unhealthy, unknown, degraded, or updating.
Required parameters
agent_id(path): the ID of the agent.
Response
A successful call returns 200 OK with the Agent object. Its required fields are id, created_by, name, dataset_id, guardrails_violation_message, url, and api_token.
Related: List agents, Update an agent, List an agent's versions
404Not Found
422Unprocessable Entity
500Internal Server Error