WhatsApp · Business Agent

Create a connector tool

Creates a connector tool.

POSThttps://api.pozy.ai/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools
createBusinessAgentConnectorTool

Guide: Business AI agent

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
accountIdrequiredstring
connectorIdrequiredstring

Request body

application/json, required

  • namestringrequired
  • descriptionstringrequired
  • request_definitionobjectrequired
  • user_auth_requiredboolean
  • user_auth_action_configobject
  • transformation_specobject

Example

curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/connectors/621ec5581aee08ee5f23dcde/tools" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "description": "A short description",
  "request_definition": {}
}'

Response

201 on success

  • namestringrequired
  • descriptionstringrequired
  • request_definitionobjectrequired
  • user_auth_requiredboolean
  • user_auth_action_configobject
  • transformation_specobject
  • idstringrequired
201 response
{
  "name": "Acme",
  "description": "A short description",
  "request_definition": {},
  "user_auth_required": true,
  "user_auth_action_config": {},
  "transformation_spec": {},
  "id": "6bfebd43ddc270f6d2c56fc5"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Business Agent