Skip to main content
GET
List Agents

Notes

  • Without limit, every agent is returned. search filters by name.
  • Each agent lists its versions (version_id, version_slug, is_archived). Prompt, voice and other settings are not included; use Get agent.
  • An agent’s ID does not change when the agent is edited, so look it up once during setup and store it rather than fetching it before every call or campaign.
  • For one agent’s full configuration, call Get agent.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Query Parameters

Filter agents by name.

Example:

"EMI"

limit
integer

Number of agents to return. Leave it out to get every agent.

Required range: x >= 1
Example:

50

offset
integer
default:0

Number of items to skip (default: 0).

Required range: x >= 0
Example:

0

Response

Successful Response: A list of agents.

status
string
Example:

"success"

data
object