Get Agent
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/agent/{agent_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/agent/{agent_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/agent/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"agents": {
"id": "00000000-0000-4000-8000-0000000000a1",
"agent_display_name": "EMI reminder",
"agent_type": "outbound",
"orchestration_mode": "single_node",
"form_fields": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"inbound_number_id": "<string>",
"telephony_id": "<string>",
"template_id": "<string>",
"template_name": "<string>",
"template_label": "<string>",
"template_icon": "<string>",
"template_type": "<string>",
"is_ab_live": false,
"active_agent_version_id": "00000000-0000-4000-8000-0000000000d1",
"ab_versions": [
"<unknown>"
],
"derived_analytics_keys": "<unknown>",
"classification_labels": [
"<string>"
],
"previous_call_summary": "<unknown>",
"webcall_public_key": "<string>",
"version_details": {}
}
}{
"message": "Invalid credentials"
}{
"message": "<string>"
}{
"message": "An unexpected error occurred. Please try again later."
}Get Agent
Get one agent’s configuration by its agent_id to confirm the agent exists in this workspace and check its name, type and settings before you call with it.
GET
/
agent
/
{agent_id}
Get Agent
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/agent/{agent_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/agent/{agent_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/agent/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"agents": {
"id": "00000000-0000-4000-8000-0000000000a1",
"agent_display_name": "EMI reminder",
"agent_type": "outbound",
"orchestration_mode": "single_node",
"form_fields": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"inbound_number_id": "<string>",
"telephony_id": "<string>",
"template_id": "<string>",
"template_name": "<string>",
"template_label": "<string>",
"template_icon": "<string>",
"template_type": "<string>",
"is_ab_live": false,
"active_agent_version_id": "00000000-0000-4000-8000-0000000000d1",
"ab_versions": [
"<unknown>"
],
"derived_analytics_keys": "<unknown>",
"classification_labels": [
"<string>"
],
"previous_call_summary": "<unknown>",
"webcall_public_key": "<string>",
"version_details": {}
}
}{
"message": "Invalid credentials"
}{
"message": "<string>"
}{
"message": "An unexpected error occurred. Please try again later."
}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
Headers
(Required) Your Ringg AI API key.
Example:
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Path Parameters
(Required) ID of the agent to retrieve.
Example:
"00000000-0000-4000-8000-0000000000a1"
Query Parameters
(Optional) Send inbound to get the inbound settings of an outbound-inbound agent.
Available options:
inbound Response
Successful Response: Detailed information about the agent.
Show child attributes
Show child attributes
Was this page helpful?