Skip to main content

Workspace API

Single-workspace metadata, logo, analytics, usage, billing, SSO, operations, and nested domain dispatch.

How To Use This API Group

Use this group when a client needs to work with workspace 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
DELETE/api/w/{workspace_ref}Archive workspacesession, user_api_tokenpublic_api
GET/api/w/{workspace_ref}Get workspacesession, user_api_token, workspace_service_tokenpublic_api
PATCH/api/w/{workspace_ref}Update workspacesession, user_api_tokenpublic_api
POST/api/w/{workspace_ref}/analyticsBuild workspace analyticssession, user_api_token, workspace_service_tokenbrowser_api
GET/api/w/{workspace_ref}/enterprise-ssoGet workspace enterprise SSO settingssession, user_api_tokenbrowser_api
GET/api/w/{workspace_ref}/enterprise-sso/identitiesList workspace enterprise SSO identitiessession, user_api_tokenbrowser_api
PATCH/api/w/{workspace_ref}/enterprise-sso/identities/{identity_link_id}Update workspace enterprise SSO identitysession, user_api_tokenbrowser_api
DELETE/api/w/{workspace_ref}/enterprise-sso/oidcDisable workspace OIDC SSOsession, user_api_tokenbrowser_api
PUT/api/w/{workspace_ref}/enterprise-sso/oidcConfigure workspace OIDC SSOsession, user_api_tokenbrowser_api
DELETE/api/w/{workspace_ref}/logoDelete workspace logosession, user_api_tokenpublic_api
POST/api/w/{workspace_ref}/logoUpload workspace logosession, user_api_tokenpublic_api

Representative Request

This example uses one workspace 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>"

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 workspace 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.