Get agent

Retrieves the full configuration of a single agent by its slug.

Authentication

AuthorizationBearer

Authenticate server-side requests with a Fonema API key. Create one in the API keys section of the Dashboard and send it in the Authorization header as Bearer <token>. Keep keys out of client-side code and public repositories.

Path parameters

slugstringRequired

Unique slug of the agent. Get it from List agents or from your Fonema dashboard.

Response

namestring

Agent name.

slugstring

Unique agent identifier.

greetingstring

Opening message the agent says when the call starts.

promptstring

System prompt that defines the agent behavior.

textPromptstring

Prompt used for text/chat conversations.

voiceIdstring

Voice identifier used by the agent.

sipDialTargetstring | null

SIP destination, if configured.

numberOfAttemptinteger

Number of call attempts configured (from recallLogic).

allowReturnCallboolean

Whether the agent allows return calls.

recallLogicobject

Retry configuration. See Edit agent.

workingHoursobject

Hours when the agent can place calls. See Edit agent.

localizationsobject

Localization settings.

dtmfboolean

Whether the agent can press keypad tones (DTMF), e.g. to navigate phone menus (IVR).

transferCallDestinationsarray

Phone numbers the agent can transfer the call to. See Edit agent.

knowledgeBaseFilesarray

IDs of attached knowledge base files.

toolsarray

Tools/skills available to the agent.

configobject

Additional agent configuration (transcriber language, timeouts, webhooks, etc.).

note

Sensitive tool credentials (apiKey, token, credentialId) are never returned in the tools response.

Errors

404

Agent not found or not accessible by this API key.

GET/v1/agents/:slug

$curl -X GET "https://api.fonema.ai/v1/agents/sales-agent-ab12cd34" \
>     -H "Authorization: Bearer YOUR_API_KEY"

200OK

1{
2  "name": "Sales Agent",
3  "slug": "sales-agent-ab12cd34",
4  "greeting": "Hi, thanks for calling!",
5  "prompt": "You are a helpful sales assistant.",
6  "textPrompt": "...",
7  "voiceId": "YOUR_VOICE_ID",
8  "sipDialTarget": null,
9  "numberOfAttempt": 3,
10  "allowReturnCall": true,
11  "recallLogic": {
12    "totalCalls": 3
13  },
14  "workingHours": {},
15  "localizations": {},
16  "dtmf": false,
17  "transferCallDestinations": [],
18  "knowledgeBaseFiles": [],
19  "tools": [
20    {
21      "id": 12,
22      "name": "lookup_order",
23      "type": "API_CALL",
24      "description": "Look up an order by ID",
25      "variables": [
26        {
27          "orderId": {
28            "type": "string",
29            "description": "The order ID"
30          }
31        }
32      ],
33      "content": {
34        "functionName": "lookup_order",
35        "url": "https://example.com/api/orders"
36      }
37    }
38  ],
39  "config": {
40    "transcriberLanguage": "es-419",
41    "silenceTimeoutSeconds": 30,
42    "silenceMessages": [
43      "Are you still there?",
44      "Hello, can you hear me?"
45    ],
46    "maxDurationSeconds": 600,
47    "endOfCallWebhook": "https://example.com/webhooks/end-of-call"
48  }
49}