WhatsApp · Business Agent

Get a skill

Fetches a skill.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/business-agent/skills/{skillId}
getBusinessAgentSkill

Guide: Business AI agent

Request

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

Path parameters

NameTypeNotes
accountIdrequiredstring
skillIdrequiredstring

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/skills/66b559c8d6626f22861add91" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • titlestring

    Up to 64 characters. Matches ^[a-z0-9]+(?:-[a-z0-9]+)*$.

  • descriptionstring

    Up to 1024 characters.

  • skillstringrequired

    Up to 20000 characters.

  • idstringrequired
  • channelstring
  • created_atinteger
  • statusstring

    One of active, pending_review, blocked.

200 response
{
  "title": "Launch day",
  "description": "A short description",
  "skill": "string",
  "id": "6bfebd43ddc270f6d2c56fc5",
  "channel": "string",
  "created_at": 1,
  "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 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