Collections API
Workspace collections and artifact membership behavior.
How To Use This API Group
Use this group when a client needs to work with collections 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}/artifacts/{artifact_ref}/collections | List artifact collection memberships | session, user_api_token, workspace_service_token | public_api |
GET | /api/w/{workspace_ref}/collections | List collections | session, user_api_token, workspace_service_token | public_api |
POST | /api/w/{workspace_ref}/collections | Create collection | session, user_api_token, workspace_service_token | public_api |
DELETE | /api/w/{workspace_ref}/collections/{collection_ref}/items/{artifact_ref} | Remove artifact from collection | session, user_api_token, workspace_service_token | public_api |
PUT | /api/w/{workspace_ref}/collections/{collection_ref}/items/{artifact_ref} | Add artifact to collection | session, user_api_token, workspace_service_token | public_api |
Representative Request
This example uses one collections 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>/artifacts/<artifact_ref>/collections"
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 collections 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.