Skip to main content

Bots API

Workspace bot list, install, detail, runtime, bindings, update, delete, and channel prompt/delegate routes.

How To Use This API Group

Use this group when a client needs to work with bots behavior in Veoveo. Start with the route list, choose the method that matches the user task, then open the API reference for exact parameters and schemas.

Authentication And Scope

Most workspace routes require a signed-in session or an integration token with access to the target workspace. Keep the workspace reference and resource references from prior responses or visible app routes.

Current Routes

MethodPathSummaryAuthSurface
GET/api/w/{workspace_ref}/botsList workspace botssession, user_api_tokenpublic_api
POST/api/w/{workspace_ref}/botsInstall workspace botsession, user_api_tokenpublic_api
DELETE/api/w/{workspace_ref}/bots/{bot_ref}Remove workspace botsession, user_api_tokenpublic_api
GET/api/w/{workspace_ref}/bots/{bot_ref}Get workspace botsession, user_api_tokenpublic_api
PATCH/api/w/{workspace_ref}/bots/{bot_ref}Update workspace botsession, user_api_tokenpublic_api
GET/api/w/{workspace_ref}/bots/{bot_ref}/bindingsList workspace bot bindingssession, user_api_tokenbrowser_api
POST/api/w/{workspace_ref}/bots/{bot_ref}/profile-photo/refreshRefresh bot profile photosession, user_api_tokenbrowser_api
GET/api/w/{workspace_ref}/bots/{bot_ref}/runtimeGet workspace bot runtimesession, user_api_tokenbrowser_api

Representative Request

This example uses one bots route. Replace bracketed path values with ids from prior API responses and use the reference for the exact request body and response schema.

curl -sS \
-H "Authorization: Bearer <token>" \
"https://veoveo.ai/api/w/<workspace_ref>/bots"

Response Review

  • Check status codes and structured error details before retrying.
  • Treat returned identifiers as the values to use in follow-up calls.
  • For routes that create or update workspace facts, review the affected artifact, event, link, bot, or operation in the app.

Media To Add

  • Table: common bots calls with required references, expected result, and next review action. It helps developers choose the right route quickly. Source: this route group and the API reference.