WhatsApp · Business Agent

Run a connector tool once

Runs a connector tool once.

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

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
toolIdrequiredstring

Request body

application/json, required

  • inputstringrequired

Example

curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/connectors/621ec5581aee08ee5f23dcde/tools/6a0f57d0aed77d6a0dae4931/run" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": "string"
}'

Response

200 on success

  • outputstring
  • statusstring
200 response
{
  "output": "string",
  "status": "active"
}

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