WhatsApp · Business Agent
Returns UI skills, one page at a time.
GET
https://api.pozy.ai/v1/accounts/{accountId}/business-agent/ui-skillslistBusinessAgentUiSkills
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
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Query parameters
| Name | Type | Notes |
|---|---|---|
before | string | |
after | string | |
limit | integer | 1 to 100 |
Example
curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/ui-skills?limit=1" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/ui-skills?limit=1", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/ui-skills",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 1,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
uiSkillsarray of objectrequired8 child fields
titlestringcomponent_typestringrequiredOne of
carousel_quick_reply,carousel_url,cta_url,flow,image,interactive_list,interactive_reply_buttons,location,location_request.statusstringrequiredOne of
enabled,disabled.instructionstringrequiredflow_idintegeridstringrequiredcreated_atintegerupdated_atinteger
pagingobject
200 response
{
"uiSkills": [
{
"title": "Launch day",
"component_type": "carousel_quick_reply",
"status": "enabled",
"instruction": "string",
"flow_id": 1,
"id": "6bfebd43ddc270f6d2c56fc5",
"created_at": 1,
"updated_at": 1
}
],
"paging": {}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Business Agent
GETGet agent setup statusPOSTCreate the agentGETList agent settingsPATCHUpdate agent settingsGETList allowlisted consumersPOSTAllowlist a consumerDELRemove an allowlisted consumerGETGet business informationPUTReplace business informationDELReset business informationGETList FAQsPOSTCreate a FAQGETGet a FAQPUTUpdate a FAQDELDelete a FAQGETList crawled websitesPOSTAdd a website to crawlGETGet a crawled websitePUTUpdate a crawled websiteDELRemove a crawled websiteGETList knowledge filesPOSTUpload a knowledge fileGETGet a knowledge fileDELDelete a knowledge fileGETList skillsPOSTCreate a skillGETGet a skillPUTUpdate a skillDELDelete a skillPOSTCreate a UI skillGETGet a UI skillPUTUpdate a UI skillDELDelete a UI skillGETList connectorsPOSTCreate a connectorGETGet a connectorPUTUpdate a connectorDELDelete a connectorPOSTSet connector credentialsPOSTRefresh MCP connector toolsGETGet connector failure logsGETList connector toolsPOSTCreate a connector toolGETGet a connector toolPUTUpdate a connector toolDELDelete a connector toolPOSTRun a connector tool onceGETGet usage budgetsPUTReplace usage budgetsPOSTSend a test messagePOSTSend a business eventGETGet a business event statusGETRead evaluation dataPOSTStart an evaluation run