Operations API
Operation create, list, status, relations, cancellation, bot operation views, and timeline.
How To Use This API Group
Use this group when a client needs to work with operations 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
| Method | Path | Summary | Auth | Surface |
|---|---|---|---|---|
GET | /api/w/{workspace_ref}/bots/{bot_ref}/operations | List bot operations | session, user_api_token, workspace_service_token | public_api |
GET | /api/w/{workspace_ref}/operations | List operations | session, user_api_token, workspace_service_token | public_api |
POST | /api/w/{workspace_ref}/operations | Create operation | session, user_api_token, workspace_service_token | public_api |
GET | /api/w/{workspace_ref}/operations/{operation_ref} | Get operation | session, user_api_token, workspace_service_token | public_api |
POST | /api/w/{workspace_ref}/operations/{operation_ref}/cancel | Cancel operation | session, user_api_token, workspace_service_token | public_api |
GET | /api/w/{workspace_ref}/operations/{operation_ref}/diagnostics | Get operation diagnostics | session, user_api_token, workspace_service_token | public_api |
GET | /api/w/{workspace_ref}/operations/{operation_ref}/events | List operation events | session, user_api_token, workspace_service_token | public_api |
GET | /api/w/{workspace_ref}/operations/{operation_ref}/relations | List operation relations | session, user_api_token, workspace_service_token | public_api |
GET | /api/w/{workspace_ref}/operations/{operation_ref}/runs | List operation runs | session, user_api_token, workspace_service_token | public_api |
GET | /api/w/{workspace_ref}/operations/{operation_ref}/subscribe | Subscribe to operation events | session, user_api_token, workspace_service_token | browser_api |
POST | /api/w/{workspace_ref}/operations/timeline | Build operation timeline | session, user_api_token, workspace_service_token | browser_api |
Representative Request
This example uses one operations 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/<bot_ref>/operations"
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 operations 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.