Skip to main content
GET
Get Agent
The agent is returned under agents as an object. Agent-level fields, such as agent_display_name, agent_type and active_agent_version_id, sit at the top; each version’s language, voice, prompt (agent_config), tools, knowledge bases, call_config and event_subscriptions sit under version_details, keyed by version ID. For an outbound-inbound agent, add type=inbound to get its inbound settings. A 404 means no agent with that ID exists in the workspace that owns the API key. Use it to check that an agent_id stored in your system still points at the agent you expect, for example after a call behaved unexpectedly.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Path Parameters

agent_id
string
required

(Required) ID of the agent to retrieve.

Example:

"00000000-0000-4000-8000-0000000000a1"

Query Parameters

type
enum<string>

(Optional) Send inbound to get the inbound settings of an outbound-inbound agent.

Available options:
inbound

Response

Successful Response: Detailed information about the agent.

agents
object