API ReferenceAgents
Get agent test code and channel links
Returns the agent test code and ready-to-use links for WhatsApp, Instagram, Messenger, and telephony test deployment. Creates a code on first request if the agent does not have one yet.
Authorization
ApiKeyAuth AuthorizationBearer <token>
Team API key (prefix sk_). You may also send the key via X-Api-Key header.
In: header
Path Parameters
agentId*string
Response Body
application/json
curl -X GET "https://example.com/api/v1/console/agents/string/deployment/agent-test-code"{ "message": "Success", "data": { "code": "ABC123XY", "channels": { "whatsapp": { "is_enabled": true, "start_message": "start ABC123XY", "phone_number": "+14155552671", "url": "https://wa.me/14155552671?text=start%20ABC123XY" }, "instagram": { "is_enabled": true, "start_message": "start ABC123XY", "username": "bimpeaiagent", "url": "https://ig.me/m/bimpeaiagent?text=start%20ABC123XY" }, "messenger": { "is_enabled": false, "start_message": "start ABC123XY", "page": "bimpeai", "url": "https://m.me/bimpeai?text=start%20ABC123XY" }, "telephony": { "is_enabled": true } } }}