API reference · AI agents

Create an agent

Create an AI agent on a linked WhatsApp number, then activate it with POST /v1/whatsapp/agents/{agent_id}/activate.

POST/v1/whatsapp/agents

Bearer API key
Rate limit 120 / min
Returns 201 Created
Needs the WhatsApp permission · 1 credit per agent reply

POST /v1/whatsapp/agents

curl https://api.talks.africa/v1/whatsapp/agents \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subscription_id": "sub_amani01",
    "name": "Amani Salon assistant",
    "system_prompt": "You are the friendly booking assistant for Amani Salon.",
    "greeting_message": "Habari! How can I help today?",
    "auto_respond": true
  }'

{
  "id": "agt_92kd",
  "name": "Amani Salon assistant",
  "status": "inactive",
  "auto_respond": true,
  "conversation_count": 0
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Body parameters

subscription_idstringoptional
The WhatsApp number it answers on.
namestringoptional
Agent name.
system_promptstringoptional
How it behaves and talks.
system_contextstringoptional
Facts about your business.
greeting_messagestringoptional
First message to new customers.
modelstringoptional
From GET /v1/whatsapp/agents/models.
temperaturenumberoptional
Lower is more predictable.
auto_respondbooleanoptional
Reply automatically.

Response fieldsResponse

id
Agent ID
status
active or inactive
conversation_count · message_count
Usage

Errors

Tap one to see its response above.

All errors use the standard error object. Select one to see its response.

Was this page helpful?