Get Agent By Id

Get an agent by id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

Path Params
string
required
Responses

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json