import requests
url = "https://api.pingr.ai/api/v1/agents/agent_12345"
headers = {
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())
const response = await fetch(
"https://api.pingr.ai/api/v1/agents/agent_12345",
{
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
}
);
const data = await response.json();
console.log(data);
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.pingr.ai/api/v1/agents/agent_12345"))
.header("Authorization", "Bearer <token>")
.GET()
.build();
HttpResponse<String> response =
HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
curl -X GET \
"https://api.pingr.ai/api/v1/agents/agent_12345" \
-H "Authorization: Bearer <token>"
{
"id": "agent_12345",
"name": "Sales Assistant",
"status": "active",
"description": "Handles inbound sales calls",
"created_at": "2024-05-20T10:15:30Z",
"updated_at": "2024-05-22T14:22:10Z",
"configuration": {
"language": "en-US",
"voice": "alloy",
"model": "gpt-4o-mini",
"temperature": 0.3
},
"tasks": [
"qualify_leads",
"book_meeting",
"send_followup_email"
]
}
{
"error": 123,
"message": "Invalid or missing agent_id"
}
{
"error": 401,
"message": "Unauthorized"
}
{
"error": 404,
"message": "Agent not found"
}
{
"error": 500,
"message": "Internal server error"
}
Agents
Get agent
Retrieve detailed Voice AI agent information, including configuration, status, and tasks.
GET
/
api
/
v1
/
agents
/
{agent_id}
import requests
url = "https://api.pingr.ai/api/v1/agents/agent_12345"
headers = {
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())
const response = await fetch(
"https://api.pingr.ai/api/v1/agents/agent_12345",
{
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
}
);
const data = await response.json();
console.log(data);
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.pingr.ai/api/v1/agents/agent_12345"))
.header("Authorization", "Bearer <token>")
.GET()
.build();
HttpResponse<String> response =
HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
curl -X GET \
"https://api.pingr.ai/api/v1/agents/agent_12345" \
-H "Authorization: Bearer <token>"
{
"id": "agent_12345",
"name": "Sales Assistant",
"status": "active",
"description": "Handles inbound sales calls",
"created_at": "2024-05-20T10:15:30Z",
"updated_at": "2024-05-22T14:22:10Z",
"configuration": {
"language": "en-US",
"voice": "alloy",
"model": "gpt-4o-mini",
"temperature": 0.3
},
"tasks": [
"qualify_leads",
"book_meeting",
"send_followup_email"
]
}
{
"error": 123,
"message": "Invalid or missing agent_id"
}
{
"error": 401,
"message": "Unauthorized"
}
{
"error": 404,
"message": "Agent not found"
}
{
"error": 500,
"message": "Internal server error"
}
Retrieve complete operational metadata, runtime parameters, voice configuration, task definitions, and current status for an existing agent by its unique identifier.
Authentication
This endpoint requires Bearer token authentication.Authorization: Bearer <token>
| Header | Type | Required | Description | Format |
|---|---|---|---|---|
Authorization | string | Yes | Scoped organization API key or Bearer JWT token | Bearer <token> |
Input parameters
The following parameters are required to call this endpoint.string
required
Unique identifier of the agent. Example:
agent_12345 or UUID 550e8400-e29b-41d4-a716-446655440000.string
required
Bearer token for authentication. Format:
Bearer <token>.Response Fields
string
Unique identifier of the agent.
string
Display name assigned to the voice agent.
string
Operational state of the agent (
active, inactive, training).string
Detailed explanation of the agent’s persona and conversational role.
string
ISO 8601 timestamp when the agent was created.
string
ISO 8601 timestamp when the agent configuration was last modified.
object
Runtime settings governing conversational synthesis:
string[]
List of capability tasks and functions assigned to this agent (e.g.
qualify_leads, book_meeting, send_followup_email).import requests
url = "https://api.pingr.ai/api/v1/agents/agent_12345"
headers = {
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())
const response = await fetch(
"https://api.pingr.ai/api/v1/agents/agent_12345",
{
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
}
);
const data = await response.json();
console.log(data);
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.pingr.ai/api/v1/agents/agent_12345"))
.header("Authorization", "Bearer <token>")
.GET()
.build();
HttpResponse<String> response =
HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
curl -X GET \
"https://api.pingr.ai/api/v1/agents/agent_12345" \
-H "Authorization: Bearer <token>"
{
"id": "agent_12345",
"name": "Sales Assistant",
"status": "active",
"description": "Handles inbound sales calls",
"created_at": "2024-05-20T10:15:30Z",
"updated_at": "2024-05-22T14:22:10Z",
"configuration": {
"language": "en-US",
"voice": "alloy",
"model": "gpt-4o-mini",
"temperature": 0.3
},
"tasks": [
"qualify_leads",
"book_meeting",
"send_followup_email"
]
}
{
"error": 123,
"message": "Invalid or missing agent_id"
}
{
"error": 401,
"message": "Unauthorized"
}
{
"error": 404,
"message": "Agent not found"
}
{
"error": 500,
"message": "Internal server error"
}
‹ PreviousNext ›
Create agent
Provision a new conversational Voice AI prompt agent
Was this page helpful?