curl --request GET \
--url https://app.thinnest.ai/api/v1/agents/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.thinnest.ai/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.thinnest.ai/api/v1/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71",
"name": "Skyline Sales",
"instructions": "You call people who enquired about a flat at Sky Towers, Baner. Find out their budget, preferred size and when they can visit the site.",
"greeting": "Namaste, I'm calling from Skyline Homes about your enquiry for Sky Towers.",
"businessDescription": "Skyline Homes builds 2 and 3 BHK apartments in Pune.",
"model": "prana-voice",
"temperature": 0.3,
"maxReplyTokens": 300,
"language": "Hindi",
"secondLanguage": "English",
"escalation": {
"onNoAnswer": false,
"onRequest": true
},
"captureLeads": true,
"scheduleCallbacks": false,
"steps": [
{
"title": "Confirm the enquiry",
"detail": "Check they enquired about Sky Towers and are still looking.",
"branches": [],
"collect": []
},
{
"title": "Budget and size",
"detail": "Ask for their budget and whether they want a 2 BHK or a 3 BHK.",
"branches": [],
"collect": []
}
],
"widget": {
"theme": "classic",
"accent": "#0f766e",
"height": 806,
"welcomeScreen": true,
"welcomeCollectLeads": true
},
"voice": {
"answersCalls": true,
"surfaces": [
"web",
"whatsapp",
"phone"
],
"voice": "priya",
"phoneNumber": "+918047361290",
"language": null,
"summariseCalls": true,
"detectMachines": false,
"recordCalls": true,
"maxCallSeconds": 300,
"pastConversations": "quiet"
},
"collectFields": [
{
"name": "budget",
"type": "number",
"description": "Budget in rupees",
"choices": null
},
{
"name": "interest",
"type": "text",
"description": null,
"choices": [
"Hot",
"Warm",
"Cold"
]
}
],
"webKey": "pk_9fQ2xLm7Rt4vWb8KcN3hYd6sJ1pZ",
"createdAt": "2026-09-17T09:39:31.204Z"
}{
"error": "Send a valid API key as `Authorization: Bearer <key>`."
}{
"error": "That agent was not found."
}{
"error": "Over 240 requests a minute. Slow down and retry."
}Get Agent
One agent: its instructions, model, languages, script, widget, call settings and the details it collects from calls. Which engine speaks its voice or runs its model is never part of the answer.
curl --request GET \
--url https://app.thinnest.ai/api/v1/agents/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.thinnest.ai/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.thinnest.ai/api/v1/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71",
"name": "Skyline Sales",
"instructions": "You call people who enquired about a flat at Sky Towers, Baner. Find out their budget, preferred size and when they can visit the site.",
"greeting": "Namaste, I'm calling from Skyline Homes about your enquiry for Sky Towers.",
"businessDescription": "Skyline Homes builds 2 and 3 BHK apartments in Pune.",
"model": "prana-voice",
"temperature": 0.3,
"maxReplyTokens": 300,
"language": "Hindi",
"secondLanguage": "English",
"escalation": {
"onNoAnswer": false,
"onRequest": true
},
"captureLeads": true,
"scheduleCallbacks": false,
"steps": [
{
"title": "Confirm the enquiry",
"detail": "Check they enquired about Sky Towers and are still looking.",
"branches": [],
"collect": []
},
{
"title": "Budget and size",
"detail": "Ask for their budget and whether they want a 2 BHK or a 3 BHK.",
"branches": [],
"collect": []
}
],
"widget": {
"theme": "classic",
"accent": "#0f766e",
"height": 806,
"welcomeScreen": true,
"welcomeCollectLeads": true
},
"voice": {
"answersCalls": true,
"surfaces": [
"web",
"whatsapp",
"phone"
],
"voice": "priya",
"phoneNumber": "+918047361290",
"language": null,
"summariseCalls": true,
"detectMachines": false,
"recordCalls": true,
"maxCallSeconds": 300,
"pastConversations": "quiet"
},
"collectFields": [
{
"name": "budget",
"type": "number",
"description": "Budget in rupees",
"choices": null
},
{
"name": "interest",
"type": "text",
"description": null,
"choices": [
"Hot",
"Warm",
"Cold"
]
}
],
"webKey": "pk_9fQ2xLm7Rt4vWb8KcN3hYd6sJ1pZ",
"createdAt": "2026-09-17T09:39:31.204Z"
}{
"error": "Send a valid API key as `Authorization: Bearer <key>`."
}{
"error": "That agent was not found."
}{
"error": "Over 240 requests a minute. Slow down and retry."
}Authorizations
Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.
Headers
Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.
"org_3fKq9TzQ1mN8vB2xR7cLpA"
Path Parameters
The agent's id (ag_…), as List Agents returns it. Another workspace's agent is the same 404 as one that never existed.
Response
The agent.
An agent as the console shows it.
The agent's id.
"ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71"
The agent's name, 2 to 60 characters.
What the agent is and how it behaves — its standing prompt.
The first thing it says, or an empty string.
One line about the business, or an empty string.
A model id from List Models. null when the agent is on a model that has since been retired.
How adventurous the wording is.
0 <= x <= 2The longest a reply may be, in tokens — one ceiling for chat and calls.
100 <= x <= 800auto (reply in the customer's language) or the language it always replies in, e.g. Hindi.
A second language it may switch to, or null.
When the agent hands the conversation to a person on your team.
Show child attributes
Show child attributes
Whether it takes a name, email or phone number from an interested customer.
Whether it may book a call back when asked.
Its conversation script, in order.
Show child attributes
Show child attributes
The website chat widget's look.
Show child attributes
Show child attributes
How it handles calls. null when the agent has no voice channel (a deployment without voice).
Show child attributes
Show child attributes
The details it fills in after every call, in the shape a call's extract takes. Empty when it collects nothing.
Show child attributes
Show child attributes
The public key the website widget embeds (pk_…). It is published on your site, so it is not a secret.
When the agent was made.