Chatbot and AI
Create/Edit AI Agent
Creates, edits or deletes an AI agent for automatic support. Send an empty id to create; filled to edit; delete=true to delete.
POST
https://api.zapzapapi.com/api/v1/{instanceId}/agent/editAuthentication with the x-api-key and x-api-secret headers.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id | text | body | No | Agent ID |
delete | select | body | No | Delete |
agent | json | body | Yes | Agent (JSON) |
Request example
curl
curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/agent/edit" \
-H "x-api-key: YOUR_API_KEY" \
-H "x-api-secret: YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"agent":{"name":"Assistente","provider":"openai","apikey":"sk-...","model":"gpt-4o-mini","basePrompt":"Voce é um assistente...","maxTokens":2000,"temperature":70,"diversityLevel":50,"frequencyPenalty":30,"presencePenalty":30,"signMessages":true,"readMessages":true,"maxMessageLength":500,"typingDelay_seconds":3,"contextTimeWindow_hours":24,"contextMaxMessages":50,"contextMinMessages":3}}'Node.js
const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/agent/edit", {
method: "POST",
headers: {
"x-api-key": "YOUR_API_KEY",
"x-api-secret": "YOUR_API_SECRET",
"Content-Type": "application/json",
},
body: JSON.stringify({
"agent": {
"name": "Assistente",
"provider": "openai",
"apikey": "sk-...",
"model": "gpt-4o-mini",
"basePrompt": "Voce é um assistente...",
"maxTokens": 2000,
"temperature": 70,
"diversityLevel": 50,
"frequencyPenalty": 30,
"presencePenalty": 30,
"signMessages": true,
"readMessages": true,
"maxMessageLength": 500,
"typingDelay_seconds": 3,
"contextTimeWindow_hours": 24,
"contextMaxMessages": 50,
"contextMinMessages": 3
}
}),
});
console.log(await res.json());Python
import requests
res = requests.post(
"https://api.zapzapapi.com/api/v1/{instanceId}/agent/edit",
headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
json={"agent":{"name":"Assistente","provider":"openai","apikey":"sk-...","model":"gpt-4o-mini","basePrompt":"Voce é um assistente...","maxTokens":2000,"temperature":70,"diversityLevel":50,"frequencyPenalty":30,"presencePenalty":30,"signMessages":True,"readMessages":True,"maxMessageLength":500,"typingDelay_seconds":3,"contextTimeWindow_hours":24,"contextMaxMessages":50,"contextMinMessages":3}},
)
print(res.json())Response example
JSON
{
"id": "read16c9f35642c",
"name": "Assistente",
"provider": "openai",
"model": "gpt-4o-mini",
"apikey": "sk-...",
"basePrompt": "Voce e um assistente...",
"maxTokens": 500,
"temperature": 70,
"diversityLevel": 0,
"frequencyPenalty": 0,
"presencePenalty": 0,
"signMessages": false,
"readMessages": false,
"maxMessageLength": 0,
"typingDelay_seconds": 0,
"contextTimeWindow_hours": 0,
"contextMaxMessages": 0,
"contextMinMessages": 0
}Values are illustrative; the fields follow the real response format.
Other endpoints in this category
Get your API keys
Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.