Skip to main content
GET
Get Assistant By ID
Fetch details for one assistant. Use this after an operator selects an assistant or when debugging why a call did not behave as expected.

Useful checks

  • Confirm the assistant exists in the current workspace.
  • Inspect call direction, prompt configuration, variables, and assigned resources.
  • Verify the assistant is the one your integration intended to use.

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Path Parameters

agent_id
string
required

(Required) ID of the assistant to retrieve.

Example:

"830f767a-397e-4b39-82ff-235cd344e2f9"

Response

Successful Response: Detailed information about the assistant.

agents
object