Botpress API

ADKAPI ReferenceIndiaMART / Versalence Agent Builder

Agent Builder External API v2

Swagger style interactive documentation for listing bots, inspecting bot integrations, and retrieving conversation messages.

Servers

https://backend.versalence.online/api/v2/agent-builder/ext

Authorize · x-api-key

Entered keys stay in this browser page and are not saved in local storage.

Security: The supplied API key and webhook secret are deliberately omitted from this distributable documentation. Rotate both if this document or the original message was shared beyond authorized recipients. Browser execution requires API CORS access from the page's origin. If it is blocked, use the provided cURL commands instead.

Bot Operations

List the bots registered in the selected workspace, including build type and timestamps.

Path parameters

Name	Type	Required	Description
`workspaceId`	string	Yes	Workspace identifier

Responses

200 Successful response · application/json

Example response

Try it out

workspaceId

Fetch integration status and webhook configuration for the requested bot. Treat the response as sensitive because it can contain a webhook secret.

Path parameters

Name	Type	Required	Description
`workspaceId`	string	Yes	Workspace identifier
`botId`	UUID	Yes	Bot identifier

Responses

200 Successful response · application/json

Example response

Try it out

workspaceIdbotId

Return conversation messages, including text and choice payloads, direction, timestamps and optional pagination token. The illustrated response is ordered newest first; sort by createdAt to reconstruct the conversation chronologically.

Path parameters

Name	Type	Required	Description
`workspaceId`	string	Yes	Workspace identifier
`botId`	UUID	Yes	Bot identifier
`conversationId`	string	Yes	Conversation identifier

Responses

200 Successful response · application/json

Example response

Try it out

workspaceIdbotIdconversationId

Authentication & examples

All endpoints require x-api-key in the request header. The base URL and documented paths combine as follows:

curl --request GET \
  --url 'https://backend.versalence.online/api/v2/agent-builder/ext/workspaces/{workspaceId}/bots' \
  --header 'x-api-key: YOUR_API_KEY'

Data model notes

Field	Meaning
`success`	Boolean indicating application level success
`data`	Endpoint result; array for bots and messages, object for integrations
`partial`	List bots response field indicating partial result in the supplied example
`nextToken`	Message pagination token; null in the supplied example. Its request parameter format is not documented in the supplied samples.
`payload`	May be text or a choice object with labeled options
`direction`	`incoming` or `outgoing`

Only HTTP 200 response bodies were provided. Error statuses, pagination request semantics, scopes, limits, and other integrations are not asserted here.