v1

latestOpenAPI 3.0.02026-07-2633090.6 KB

agent

Get Assistants

Retrieves a list of all available assistants in your workspace.

get/agent/all

Query parameters

limitinteger

Example:50

Number of items to return (default: 20, max: 100).

offsetinteger

Example:20

Number of items to skip (default: 0).

Headers

X-API-KEYstring required

Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Response

Successful Response: A list of assistants.

statusstring

Example response

{
  "data": {
    "agents": [
      {
        "id": "830f767a-397e-4b39-82ff-235cd344e2f9",
        "agent_display_name": "Sales Assistant",
        "agent_type": "outbound",
        "created_at": "2024-12-16T13:03:29.947147+00:00",
        "updated_at": "2024-12-16T14:15:32.123456+00:00",
        "template_name": "sales",
        "template_label": "Sales Agent",
        "template_icon": "💼",
        "template_source": "custom",
        "call_count": 47,
        "custom_variables": {
          "callee_name": "string",
          "mobile_number": "string",
          "company": "string",
          "lead_source": "string"
        },
        "tools": [],
        "secondary_language": "hi-IN",
        "secondary_voice_id": "4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e",
        "template_type": "outbound"
      }
    ]
  }
}