Zernio
APIFor you
Zernio
APIFor you
API Reference

Meta Business Agent

Setup

Get agent setup statusGETCreate the agentPOSTList agent settingsGETUpdate agent settingsPATCHList allowlisted consumersGETAllowlist a consumerPOSTRemove an allowlisted consumerDELETE

Knowledge

Get business informationGETReplace business informationPUTReset business informationDELETEList FAQsGETCreate a FAQPOSTGet a FAQGETUpdate a FAQPUTDelete a FAQDELETEList crawled websitesGETAdd a website to crawlPOSTGet a crawled websiteGETUpdate a crawled websitePUTRemove a crawled websiteDELETEList knowledge filesGETUpload a knowledge filePOSTGet a knowledge fileGETDelete a knowledge fileDELETE

Skills

List skillsGETCreate a skillPOSTGet a skillGETUpdate a skillPUTDelete a skillDELETEList UI skillsGETCreate a UI skillPOSTGet a UI skillGETUpdate a UI skillPUTDelete a UI skillDELETE

Connectors

List connectorsGETCreate a connectorPOSTGet a connectorGETUpdate a connectorPUTDelete a connectorDELETESet connector credentialsPOSTRefresh MCP connector toolsPOSTGet connector failure logsGETList connector toolsGETCreate a connector toolPOSTGet a connector toolGETUpdate a connector toolPUTDelete a connector toolDELETERun a connector tool oncePOST

Operate

Get usage budgetsGETReplace usage budgetsPUTSend a test messagePOSTSend a business eventPOSTGet a business event statusGETRead evaluation dataGETStart an evaluation runPOST
Dashboard
OverviewPlatformsAPI ReferenceResources
Meta Business Agent

Run a connector tool once

Executes the tool against the merchant API and returns the raw upstream result, to check a connector before the agent relies on it.

POST
/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId}/run

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

accountId*string

WhatsApp social account id (the number must be managed through the Cloud API).

connectorId*string
toolId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.businessagent.runBusinessAgentConnectorTool({  path: {    accountId: 'account_abc123',    connectorId: 'connector_abc123',    toolId: 'tool_abc123',  },  body: {    input: 'string',  },});console.log(data);
{  "output": "string",  "status": "string"}
Was this page helpful?

Delete a connector tool

Previous Page

Get usage budgets

Caps over rolling windows for the Business Manager that owns the number. An empty list means unlimited.

input*string

JSON string with the tool arguments.