openapi: 3.1.0 info: title: AI Software Factory — Public API v1 version: 1.0.0 description: >- The public REST API of AI Software Factory. Base URL: `/api/v1`. ## Versioning `/api/v1` is the STABLE surface. Breaking changes ship only in a new major (`/api/v2`, side-by-side). A deprecated route carries `Deprecation: true` + `Sunset: ` headers and `deprecated: true` here. See `docs/api/versioning.md`. ## Authentication Send `Authorization: Bearer ` where `` is either a user JWT (web sessions) or an API key (`fk_live_…`). API keys act as their WORKSPACE (docs §7) and carry scopes `READ` / `WRITE` / `ADMIN`; a scope-insufficient call returns `403 FORBIDDEN` with `error.details[0].reason = "api_key_scope_write"` (public alias **SCOPE_DENIED**), a cross-workspace call returns `403 … "workspace_mismatch"`. The `:workspaceId` path segment is the authoritative workspace selector; the optional `X-Factory-Workspace` header disambiguates multi-workspace users and MUST equal the key's own workspace when present. ## Rate limits Every response carries `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. Per API key: 600 req/min by default, or the key's own `rateLimit` if set (docs §11). ## Idempotency Mutating requests may carry an `Idempotency-Key` header; 2xx responses are memoized for 24 h and replays carry `Idempotency-Replayed: true` (docs §9). ## Errors Every non-2xx response is `{ "error": { "code", "message", "details"?, "requestId" } }` (`details[].reason` is the machine-readable reason). See `docs/api/authentication.md` §9 for the canonical code table. servers: - url: /api/v1 description: Public API v1 (same-origin). Use the absolute URL in deployments. tags: - name: AI Conversations description: AI Conversations endpoints (v1). - name: Auth description: Auth endpoints (v1). - name: Automations description: Automations endpoints (v1). - name: Blocks description: Blocks endpoints (v1). - name: Comments description: Comments endpoints (v1). - name: Databases description: Databases endpoints (v1). - name: Debug description: Debug endpoints (v1). - name: API Docs description: API Docs endpoints (v1). - name: Files description: Files endpoints (v1). - name: Forms description: Forms endpoints (v1). - name: Health description: Health endpoints (v1). - name: Notifications description: Notifications endpoints (v1). - name: OAuth2 description: OAuth2 endpoints (v1). - name: Orgs description: Orgs endpoints (v1). - name: Pages description: Pages endpoints (v1). - name: Public Forms description: Public Forms endpoints (v1). - name: Records description: Records endpoints (v1). - name: Search description: Search endpoints (v1). - name: Sessions description: Sessions endpoints (v1). - name: Sharing description: Sharing endpoints (v1). - name: Templates description: Templates endpoints (v1). - name: Users description: Users endpoints (v1). - name: Webhooks description: Webhooks endpoints (v1). - name: Workspaces description: Workspaces endpoints (v1). - name: AI description: AI endpoints (v1). - name: API Keys description: API Keys endpoints (v1). - name: Audit description: Audit endpoints (v1). - name: Embeds description: Embeds endpoints (v1). - name: Integrations description: Integrations endpoints (v1). - name: Policy description: Policy endpoints (v1). - name: Tasks description: Tasks endpoints (v1). - name: Teams description: Teams endpoints (v1). paths: /ai/conversations/{id}: get: operationId: GetAiConversationsById tags: - AI Conversations summary: Get an AI conversation (user-identity only) security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchAiConversationsById tags: - AI Conversations summary: Update an AI conversation (user-identity only) security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteAiConversationsById tags: - AI Conversations summary: Delete an AI conversation (user-identity only) security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /ai/conversations/{id}/messages: get: operationId: GetAiConversationsByIdMessages tags: - AI Conversations summary: List conversation messages (user-identity only) security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/2fa/disable: post: operationId: PostAuth2faDisable tags: - Auth summary: Create auth security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/2fa/enroll: post: operationId: PostAuth2faEnroll tags: - Auth summary: Create auth security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/2fa/status: get: operationId: GetAuth2faStatus tags: - Auth summary: List auth security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/2fa/verify: post: operationId: PostAuth2faVerify tags: - Auth summary: Create auth security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/login: post: operationId: PostAuthLogin tags: - Auth summary: Log in (email + password) security: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/logout: post: operationId: PostAuthLogout tags: - Auth summary: Log out the current session security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/me: get: operationId: GetAuthMe tags: - Auth summary: Get the authenticated user security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/refresh: post: operationId: PostAuthRefresh tags: - Auth summary: Refresh the session tokens security: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/register: post: operationId: PostAuthRegister tags: - Auth summary: Register a new account security: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/reset-password: post: operationId: PostAuthResetPassword tags: - Auth summary: Request a password reset security: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/reset-password/confirm: post: operationId: PostAuthResetPasswordConfirm tags: - Auth summary: Confirm a password reset security: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /auth/sso/options: get: operationId: GetAuthSsoOptions tags: - Auth summary: "SSO discovery for the login page (anonymous, minimal-info: org slugs with SSO enabled)" security: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}: get: operationId: GetAutomationsById tags: - Automations summary: Get automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchAutomationsById tags: - Automations summary: Update automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteAutomationsById tags: - Automations summary: Delete automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/actions: put: operationId: PutAutomationsByIdActions tags: - Automations summary: Replace automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/conditions: put: operationId: PutAutomationsByIdConditions tags: - Automations summary: Replace automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/run: post: operationId: PostAutomationsByIdRun tags: - Automations summary: Create automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/runs: get: operationId: GetAutomationsByIdRuns tags: - Automations summary: Get automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/runs/{runId}: get: operationId: GetAutomationsByIdRunsByRunId tags: - Automations summary: Get automations by id + runId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: runId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/runs/{runId}/retry: post: operationId: PostAutomationsByIdRunsByRunIdRetry tags: - Automations summary: Create automations by id + runId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: runId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/status: post: operationId: PostAutomationsByIdStatus tags: - Automations summary: Create automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/triggers: put: operationId: PutAutomationsByIdTriggers tags: - Automations summary: Replace automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /automations/{id}/webhook/regenerate: post: operationId: PostAutomationsByIdWebhookRegenerate tags: - Automations summary: Create automations by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /blocks/{id}: patch: operationId: PatchBlocksById tags: - Blocks summary: Update blocks by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteBlocksById tags: - Blocks summary: Delete blocks by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /blocks/{id}/duplicate: post: operationId: PostBlocksByIdDuplicate tags: - Blocks summary: Create blocks by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /blocks/{id}/move: post: operationId: PostBlocksByIdMove tags: - Blocks summary: Create blocks by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /blocks/batch: post: operationId: PostBlocksBatch tags: - Blocks summary: Batch block operation security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /comments: get: operationId: GetComments tags: - Comments summary: List comments security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostComments tags: - Comments summary: Create comments security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /comments/{id}: patch: operationId: PatchCommentsById tags: - Comments summary: Update comments by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteCommentsById tags: - Comments summary: Delete comments by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /comments/{id}/reactions: post: operationId: PostCommentsByIdReactions tags: - Comments summary: Create comments by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /comments/{id}/reopen: post: operationId: PostCommentsByIdReopen tags: - Comments summary: Create comments by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /comments/{id}/resolve: post: operationId: PostCommentsByIdResolve tags: - Comments summary: Create comments by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{databaseId}/forms: get: operationId: GetDatabasesByDatabaseIdForms tags: - Databases summary: Get databases by databaseId security: - bearerAuth: [] parameters: - name: databaseId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostDatabasesByDatabaseIdForms tags: - Databases summary: Create databases by databaseId security: - bearerAuth: [] parameters: - name: databaseId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}: get: operationId: GetDatabasesById tags: - Databases summary: Get databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchDatabasesById tags: - Databases summary: Update databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteDatabasesById tags: - Databases summary: Delete databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/export: get: operationId: GetDatabasesByIdExport tags: - Databases summary: Get databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/formulas: get: operationId: GetDatabasesByIdFormulas tags: - Databases summary: Get databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostDatabasesByIdFormulas tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/formulas/validate: post: operationId: PostDatabasesByIdFormulasValidate tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/import/csv: post: operationId: PostDatabasesByIdImportCsv tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/properties: get: operationId: GetDatabasesByIdProperties tags: - Databases summary: Get databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostDatabasesByIdProperties tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/properties/{propertyId}: patch: operationId: PatchDatabasesByIdPropertiesByPropertyId tags: - Databases summary: Update databases by id + propertyId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: propertyId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteDatabasesByIdPropertiesByPropertyId tags: - Databases summary: Delete databases by id + propertyId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: propertyId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/properties/{propertyId}/reorder: post: operationId: PostDatabasesByIdPropertiesByPropertyIdReorder tags: - Databases summary: Create databases by id + propertyId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: propertyId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/query: post: operationId: PostDatabasesByIdQuery tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/records: get: operationId: GetDatabasesByIdRecords tags: - Databases summary: Get databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostDatabasesByIdRecords tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/records/bulk: post: operationId: PostDatabasesByIdRecordsBulk tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/relations: get: operationId: GetDatabasesByIdRelations tags: - Databases summary: Get databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostDatabasesByIdRelations tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/relations/{relationId}: patch: operationId: PatchDatabasesByIdRelationsByRelationId tags: - Databases summary: Update databases by id + relationId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: relationId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteDatabasesByIdRelationsByRelationId tags: - Databases summary: Delete databases by id + relationId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: relationId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/views: get: operationId: GetDatabasesByIdViews tags: - Databases summary: Get databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostDatabasesByIdViews tags: - Databases summary: Create databases by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/views/{viewId}: patch: operationId: PatchDatabasesByIdViewsByViewId tags: - Databases summary: Update databases by id + viewId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: viewId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteDatabasesByIdViewsByViewId tags: - Databases summary: Delete databases by id + viewId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: viewId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /databases/{id}/views/{viewId}/reorder: post: operationId: PostDatabasesByIdViewsByViewIdReorder tags: - Databases summary: Create databases by id + viewId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: viewId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /debug/events: get: operationId: GetDebugEvents tags: - Debug summary: List debug security: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /docs: get: operationId: GetDocs tags: - API Docs summary: Interactive API documentation (swagger-ui) security: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /docs/assets/{file}: get: operationId: GetDocsAssetsByFile tags: - API Docs summary: Get api docs by file security: [] parameters: - name: file in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /docs/openapi.yaml: get: operationId: GetDocsOpenapiYaml tags: - API Docs summary: Download the OpenAPI 3.1 spec (YAML) security: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files: get: operationId: GetFiles tags: - Files summary: List files security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/{id}: get: operationId: GetFilesById tags: - Files summary: Get files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteFilesById tags: - Files summary: Delete files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchFilesById tags: - Files summary: Update files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/{id}/download: get: operationId: GetFilesByIdDownload tags: - Files summary: Get files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/{id}/permissions: get: operationId: GetFilesByIdPermissions tags: - Files summary: Get files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. put: operationId: PutFilesByIdPermissions tags: - Files summary: Replace files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/{id}/preview: get: operationId: GetFilesByIdPreview tags: - Files summary: Get files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/{id}/restore: post: operationId: PostFilesByIdRestore tags: - Files summary: Restore a file from the trash security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/{id}/rollback: post: operationId: PostFilesByIdRollback tags: - Files summary: Roll a file back to a previous version security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/{id}/versions: get: operationId: GetFilesByIdVersions tags: - Files summary: Get files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/{id}/versions/prune: post: operationId: PostFilesByIdVersionsPrune tags: - Files summary: Create files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/trash: get: operationId: GetFilesTrash tags: - Files summary: List files security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/uploads: post: operationId: PostFilesUploads tags: - Files summary: Create files security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/uploads/{id}/cancel: post: operationId: PostFilesUploadsByIdCancel tags: - Files summary: Create files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /files/uploads/{id}/complete: put: operationId: PutFilesUploadsByIdComplete tags: - Files summary: Replace files by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /forms/{formId}: get: operationId: GetFormsByFormId tags: - Forms summary: Get forms by formId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchFormsByFormId tags: - Forms summary: Update forms by formId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteFormsByFormId tags: - Forms summary: Delete forms by formId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /forms/{formId}/export: get: operationId: GetFormsByFormIdExport tags: - Forms summary: Get forms by formId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /forms/{formId}/questions: get: operationId: GetFormsByFormIdQuestions tags: - Forms summary: Get forms by formId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostFormsByFormIdQuestions tags: - Forms summary: Create forms by formId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /forms/{formId}/questions/{qid}: patch: operationId: PatchFormsByFormIdQuestionsByQid tags: - Forms summary: Update forms by formId + qid security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string - name: qid in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteFormsByFormIdQuestionsByQid tags: - Forms summary: Delete forms by formId + qid security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string - name: qid in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /forms/{formId}/questions/reorder: post: operationId: PostFormsByFormIdQuestionsReorder tags: - Forms summary: Create forms by formId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /forms/{formId}/submissions: get: operationId: GetFormsByFormIdSubmissions tags: - Forms summary: Get forms by formId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /forms/{formId}/submissions/{submissionId}: delete: operationId: DeleteFormsByFormIdSubmissionsBySubmissionId tags: - Forms summary: Delete forms by formId + submissionId security: - bearerAuth: [] parameters: - name: formId in: path required: true schema: type: string - name: submissionId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /health: get: operationId: GetHealth tags: - Health summary: Liveness/readiness probe security: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /health/deep: get: operationId: GetHealthDeep tags: - Health summary: Liveness/readiness probe security: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /health/ready: get: operationId: GetHealthReady tags: - Health summary: Liveness/readiness probe security: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /notifications: get: operationId: GetNotifications tags: - Notifications summary: List notifications security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /notifications/{id}/read: post: operationId: PostNotificationsByIdRead tags: - Notifications summary: Create notifications by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /notifications/preferences: get: operationId: GetNotificationsPreferences tags: - Notifications summary: List notifications security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchNotificationsPreferences tags: - Notifications summary: Update notifications security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /notifications/read-all: post: operationId: PostNotificationsReadAll tags: - Notifications summary: Mark all notifications read security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /notifications/unread-count: get: operationId: GetNotificationsUnreadCount tags: - Notifications summary: Get the unread notification count security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /oauth/authorize: get: operationId: GetOauthAuthorize tags: - OAuth2 summary: List oauth2 security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostOauthAuthorize tags: - OAuth2 summary: Create oauth2 security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /oauth/clients/{clientId}: get: operationId: GetOauthClientsByClientId tags: - OAuth2 summary: Get oauth2 by clientId security: - bearerAuth: [] parameters: - name: clientId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /oauth/revoke: post: operationId: PostOauthRevoke tags: - OAuth2 summary: Create oauth2 security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /oauth/token: post: operationId: PostOauthToken tags: - OAuth2 summary: Create oauth2 security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs: get: operationId: GetOrgs tags: - Orgs summary: List the caller's organizations security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostOrgs tags: - Orgs summary: Create an organization security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{id}: get: operationId: GetOrgsById tags: - Orgs summary: Get orgs by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchOrgsById tags: - Orgs summary: Update orgs by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{id}/members/invites: post: operationId: PostOrgsByIdMembersInvites tags: - Orgs summary: Create orgs by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/analytics: get: operationId: GetOrgsByOrgIdAdminAnalytics tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/audit: get: operationId: GetOrgsByOrgIdAdminAudit tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/audit/actions: get: operationId: GetOrgsByOrgIdAdminAuditActions tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/audit/export: post: operationId: PostOrgsByOrgIdAdminAuditExport tags: - Orgs summary: Create orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/audit/exports/{exportId}: get: operationId: GetOrgsByOrgIdAdminAuditExportsByExportId tags: - Orgs summary: Get orgs by orgId + exportId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - name: exportId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/jobs: get: operationId: GetOrgsByOrgIdAdminJobs tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/jobs/failed: get: operationId: GetOrgsByOrgIdAdminJobsFailed tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/jobs/requeue: post: operationId: PostOrgsByOrgIdAdminJobsRequeue tags: - Orgs summary: Create orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/members: get: operationId: GetOrgsByOrgIdAdminMembers tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/members/{userId}: patch: operationId: PatchOrgsByOrgIdAdminMembersByUserId tags: - Orgs summary: Update orgs by orgId + userId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/notifications/health: get: operationId: GetOrgsByOrgIdAdminNotificationsHealth tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/overview: get: operationId: GetOrgsByOrgIdAdminOverview tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/policy: get: operationId: GetOrgsByOrgIdAdminPolicy tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchOrgsByOrgIdAdminPolicy tags: - Orgs summary: Update orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/retention: get: operationId: GetOrgsByOrgIdAdminRetention tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchOrgsByOrgIdAdminRetention tags: - Orgs summary: Update orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/retention/run: post: operationId: PostOrgsByOrgIdAdminRetentionRun tags: - Orgs summary: Create orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/retention/runs/{runId}: get: operationId: GetOrgsByOrgIdAdminRetentionRunsByRunId tags: - Orgs summary: Get orgs by orgId + runId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - name: runId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/search/health: get: operationId: GetOrgsByOrgIdAdminSearchHealth tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/search/reindex: post: operationId: PostOrgsByOrgIdAdminSearchReindex tags: - Orgs summary: Create orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/admin/workspaces: get: operationId: GetOrgsByOrgIdAdminWorkspaces tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/scim: get: operationId: GetOrgsByOrgIdScim tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostOrgsByOrgIdScim tags: - Orgs summary: Create orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchOrgsByOrgIdScim tags: - Orgs summary: Update orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/scim/test: post: operationId: PostOrgsByOrgIdScimTest tags: - Orgs summary: Create orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/sso: get: operationId: GetOrgsByOrgIdSso tags: - Orgs summary: Get orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostOrgsByOrgIdSso tags: - Orgs summary: Create orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchOrgsByOrgIdSso tags: - Orgs summary: Update orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteOrgsByOrgIdSso tags: - Orgs summary: Delete orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/sso/enforce: patch: operationId: PatchOrgsByOrgIdSsoEnforce tags: - Orgs summary: Update orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /orgs/{orgId}/sso/test: post: operationId: PostOrgsByOrgIdSsoTest tags: - Orgs summary: Create orgs by orgId security: - bearerAuth: [] parameters: - name: orgId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}: get: operationId: GetPagesById tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchPagesById tags: - Pages summary: Update pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeletePagesById tags: - Pages summary: Delete pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/backlinks: get: operationId: GetPagesByIdBacklinks tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/duplicate: post: operationId: PostPagesByIdDuplicate tags: - Pages summary: Create pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/export/markdown: get: operationId: GetPagesByIdExportMarkdown tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/favorite: get: operationId: GetPagesByIdFavorite tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostPagesByIdFavorite tags: - Pages summary: Create pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeletePagesByIdFavorite tags: - Pages summary: Delete pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/move: post: operationId: PostPagesByIdMove tags: - Pages summary: Create pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/permanent: delete: operationId: DeletePagesByIdPermanent tags: - Pages summary: Permanently delete a page security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/restore: post: operationId: PostPagesByIdRestore tags: - Pages summary: Restore a page from the trash security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/review: get: operationId: GetPagesByIdReview tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostPagesByIdReview tags: - Pages summary: Create pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/templates: post: operationId: PostPagesByIdTemplates tags: - Pages summary: Save a page as a template security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/versions: get: operationId: GetPagesByIdVersions tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostPagesByIdVersions tags: - Pages summary: Create pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/versions/{versionId}: get: operationId: GetPagesByIdVersionsByVersionId tags: - Pages summary: Get pages by id + versionId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: versionId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/versions/{versionId}/restore: post: operationId: PostPagesByIdVersionsByVersionIdRestore tags: - Pages summary: Create pages by id + versionId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: versionId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/versions/compare: get: operationId: GetPagesByIdVersionsCompare tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/watch: get: operationId: GetPagesByIdWatch tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostPagesByIdWatch tags: - Pages summary: Create pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeletePagesByIdWatch tags: - Pages summary: Delete pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/whiteboard: get: operationId: GetPagesByIdWhiteboard tags: - Pages summary: Get pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. put: operationId: PutPagesByIdWhiteboard tags: - Pages summary: Replace pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{id}/whiteboard/convert: post: operationId: PostPagesByIdWhiteboardConvert tags: - Pages summary: Create pages by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{pageId}/blocks: get: operationId: GetPagesByPageIdBlocks tags: - Pages summary: Get pages by pageId security: - bearerAuth: [] parameters: - name: pageId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostPagesByPageIdBlocks tags: - Pages summary: Create pages by pageId security: - bearerAuth: [] parameters: - name: pageId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/{pageId}/content: get: operationId: GetPagesByPageIdContent tags: - Pages summary: Get pages by pageId security: - bearerAuth: [] parameters: - name: pageId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /pages/bulk: post: operationId: PostPagesBulk tags: - Pages summary: Create pages security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /public/forms/{slug}: get: operationId: GetPublicFormsBySlug tags: - Public Forms summary: Open a public form (unauthenticated) security: [] parameters: - name: slug in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /public/forms/{slug}/files: post: operationId: PostPublicFormsBySlugFiles tags: - Public Forms summary: Create public forms by slug security: [] parameters: - name: slug in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /public/forms/{slug}/files/{fileId}/complete: put: operationId: PutPublicFormsBySlugFilesByFileIdComplete tags: - Public Forms summary: Replace public forms by slug + fileId security: [] parameters: - name: slug in: path required: true schema: type: string - name: fileId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /public/forms/{slug}/submit: post: operationId: PostPublicFormsBySlugSubmit tags: - Public Forms summary: Submit a public form (unauthenticated) security: [] parameters: - name: slug in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /records/{id}: get: operationId: GetRecordsById tags: - Records summary: Get records by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchRecordsById tags: - Records summary: Update records by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteRecordsById tags: - Records summary: Delete records by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /records/{id}/formula/{formulaId}: get: operationId: GetRecordsByIdFormulaByFormulaId tags: - Records summary: Get records by id + formulaId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: formulaId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /records/{id}/relations: get: operationId: GetRecordsByIdRelations tags: - Records summary: Get records by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /search: post: operationId: PostSearch tags: - Search summary: Run a workspace search security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /search/query: get: operationId: GetSearchQuery tags: - Search summary: List search security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /search/recent: get: operationId: GetSearchRecent tags: - Search summary: List search security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. put: operationId: PutSearchRecent tags: - Search summary: Replace search security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteSearchRecent tags: - Search summary: Delete search security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /search/suggest: get: operationId: GetSearchSuggest tags: - Search summary: List search security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /sessions: get: operationId: GetSessions tags: - Sessions summary: List sessions security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteSessions tags: - Sessions summary: End all other sessions security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /sessions/{id}: delete: operationId: DeleteSessionsById tags: - Sessions summary: Delete sessions by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /share/{slug}: get: operationId: GetShareBySlug tags: - Sharing summary: Get sharing by slug security: [] parameters: - name: slug in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /shares: post: operationId: PostShares tags: - Sharing summary: Create sharing security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /shares/{id}: delete: operationId: DeleteSharesById tags: - Sharing summary: Delete sharing by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /shares/{workspaceId}: get: operationId: GetSharesByWorkspaceId tags: - Sharing summary: Get sharing by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /templates/{id}/apply: post: operationId: PostTemplatesByIdApply tags: - Templates summary: Create templates by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /templates/{id}/preview: get: operationId: GetTemplatesByIdPreview tags: - Templates summary: Get templates by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /templates/{id}/versions: post: operationId: PostTemplatesByIdVersions tags: - Templates summary: Create templates by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. get: operationId: GetTemplatesByIdVersions tags: - Templates summary: Get templates by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /templates/{id}/versions/{versionId}/restore: post: operationId: PostTemplatesByIdVersionsByVersionIdRestore tags: - Templates summary: Create templates by id + versionId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: versionId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /users: get: operationId: GetUsers tags: - Users summary: List users (workspace context) security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /users/me: get: operationId: GetUsersMe tags: - Users summary: Get the current user security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchUsersMe tags: - Users summary: Update users security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /users/me/activity: get: operationId: GetUsersMeActivity tags: - Users summary: List users security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /users/me/profile: get: operationId: GetUsersMeProfile tags: - Users summary: List users security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /users/me/recent: put: operationId: PutUsersMeRecent tags: - Users summary: Replace users security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. get: operationId: GetUsersMeRecent tags: - Users summary: List users security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /users/me/saved-searches: get: operationId: GetUsersMeSavedSearches tags: - Users summary: List users security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostUsersMeSavedSearches tags: - Users summary: Create users security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /users/me/saved-searches/{id}: get: operationId: GetUsersMeSavedSearchesById tags: - Users summary: Get users by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchUsersMeSavedSearchesById tags: - Users summary: Update users by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteUsersMeSavedSearchesById tags: - Users summary: Delete users by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /webhooks/incoming/{webhookId}: post: operationId: PostWebhooksIncomingByWebhookId tags: - Webhooks summary: Receive an incoming automation webhook payload security: [] parameters: - name: webhookId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces: get: operationId: GetWorkspaces tags: - Workspaces summary: List workspaces security: - bearerAuth: [] parameters: [] responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostWorkspaces tags: - Workspaces summary: Create workspaces security: - bearerAuth: [] parameters: - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}: get: operationId: GetWorkspacesById tags: - Workspaces summary: Get workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchWorkspacesById tags: - Workspaces summary: Update workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteWorkspacesById tags: - Workspaces summary: Delete workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/activity: get: operationId: GetWorkspacesByIdActivity tags: - Workspaces summary: Get workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/archive: post: operationId: PostWorkspacesByIdArchive tags: - Workspaces summary: Create workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/archive/restore: post: operationId: PostWorkspacesByIdArchiveRestore tags: - Workspaces summary: Create workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/databases: get: operationId: GetWorkspacesByIdDatabases tags: - Workspaces summary: Get workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/members: get: operationId: GetWorkspacesByIdMembers tags: - Workspaces summary: Get workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/members/{userId}: patch: operationId: PatchWorkspacesByIdMembersByUserId tags: - Workspaces summary: Update workspaces by id + userId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: userId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteWorkspacesByIdMembersByUserId tags: - Workspaces summary: Delete workspaces by id + userId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: userId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/members/invites: post: operationId: PostWorkspacesByIdMembersInvites tags: - Workspaces summary: Create workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/members/invites/{inviteId}/accept: post: operationId: PostWorkspacesByIdMembersInvitesByInviteIdAccept tags: - Workspaces summary: Create workspaces by id + inviteId security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: inviteId in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/stats: get: operationId: GetWorkspacesByIdStats tags: - Workspaces summary: Get workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/transfer: post: operationId: PostWorkspacesByIdTransfer tags: - Workspaces summary: Create workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{id}/usage: get: operationId: GetWorkspacesByIdUsage tags: - Workspaces summary: Get workspaces by id security: - bearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/assistant/apply-metadata: post: operationId: PostWorkspacesByWorkspaceIdAiAssistantApplyMetadata tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/assistant/extract-actions: post: operationId: PostWorkspacesByWorkspaceIdAiAssistantExtractActions tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/assistant/find-duplicates: post: operationId: PostWorkspacesByWorkspaceIdAiAssistantFindDuplicates tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/assistant/find-stale: post: operationId: PostWorkspacesByWorkspaceIdAiAssistantFindStale tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/assistant/generate-faqs: post: operationId: PostWorkspacesByWorkspaceIdAiAssistantGenerateFaqs tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/assistant/suggest-metadata: post: operationId: PostWorkspacesByWorkspaceIdAiAssistantSuggestMetadata tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/chat: post: operationId: PostWorkspacesByWorkspaceIdAiChat tags: - AI summary: AI chat (user-identity only) security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/conversations: get: operationId: GetWorkspacesByWorkspaceIdAiConversations tags: - AI summary: List AI conversations (user-identity only) security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostWorkspacesByWorkspaceIdAiConversations tags: - AI summary: Create an AI conversation (user-identity only) security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/conversations/{conversationId}/messages: post: operationId: PostWorkspacesByWorkspaceIdAiConversationsByConversationIdMessages tags: - AI summary: Send a message in a conversation (user-identity only) security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: conversationId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/databases/extract: post: operationId: PostWorkspacesByWorkspaceIdAiDatabasesExtract tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/databases/extract/preview: post: operationId: PostWorkspacesByWorkspaceIdAiDatabasesExtractPreview tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/databases/formulas: post: operationId: PostWorkspacesByWorkspaceIdAiDatabasesFormulas tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/databases/generate: post: operationId: PostWorkspacesByWorkspaceIdAiDatabasesGenerate tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/generate: post: operationId: PostWorkspacesByWorkspaceIdAiGenerate tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/ping: post: operationId: PostWorkspacesByWorkspaceIdAiPing tags: - AI summary: AI availability ping security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/search: post: operationId: PostWorkspacesByWorkspaceIdAiSearch tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/writing: post: operationId: PostWorkspacesByWorkspaceIdAiWriting tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/ai/writing/apply: post: operationId: PostWorkspacesByWorkspaceIdAiWritingApply tags: - AI summary: Create ai by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/api-keys: post: operationId: PostWorkspacesByWorkspaceIdApiKeys tags: - API Keys summary: Create an API key security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. get: operationId: GetWorkspacesByWorkspaceIdApiKeys tags: - API Keys summary: List the workspace's API keys security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/api-keys/{id}: patch: operationId: PatchWorkspacesByWorkspaceIdApiKeysById tags: - API Keys summary: Update an API key (scope / rate limit / expiry / name) security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteWorkspacesByWorkspaceIdApiKeysById tags: - API Keys summary: Revoke an API key security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/audit: get: operationId: GetWorkspacesByWorkspaceIdAudit tags: - Audit summary: Get audit by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/automations: get: operationId: GetWorkspacesByWorkspaceIdAutomations tags: - Automations summary: Get automations by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostWorkspacesByWorkspaceIdAutomations tags: - Automations summary: Create automations by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/embeds/preview: get: operationId: GetWorkspacesByWorkspaceIdEmbedsPreview tags: - Embeds summary: Get embeds by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/integrations: get: operationId: GetWorkspacesByWorkspaceIdIntegrations tags: - Integrations summary: Get integrations by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostWorkspacesByWorkspaceIdIntegrations tags: - Integrations summary: Create integrations by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/integrations/{id}: patch: operationId: PatchWorkspacesByWorkspaceIdIntegrationsById tags: - Integrations summary: Update integrations by workspaceId + id security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteWorkspacesByWorkspaceIdIntegrationsById tags: - Integrations summary: Delete integrations by workspaceId + id security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/oauth/apps: post: operationId: PostWorkspacesByWorkspaceIdOauthApps tags: - OAuth2 summary: Create oauth2 by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. get: operationId: GetWorkspacesByWorkspaceIdOauthApps tags: - OAuth2 summary: Get oauth2 by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/oauth/apps/{clientId}: patch: operationId: PatchWorkspacesByWorkspaceIdOauthAppsByClientId tags: - OAuth2 summary: Update oauth2 by workspaceId + clientId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: clientId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteWorkspacesByWorkspaceIdOauthAppsByClientId tags: - OAuth2 summary: Delete oauth2 by workspaceId + clientId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: clientId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/pages: get: operationId: GetWorkspacesByWorkspaceIdPages tags: - Pages summary: Get pages by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostWorkspacesByWorkspaceIdPages tags: - Pages summary: Create pages by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/policy/effective: get: operationId: GetWorkspacesByWorkspaceIdPolicyEffective tags: - Policy summary: Get policy by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/tasks: get: operationId: GetWorkspacesByWorkspaceIdTasks tags: - Tasks summary: Get tasks by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostWorkspacesByWorkspaceIdTasks tags: - Tasks summary: Create tasks by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/tasks/{id}: get: operationId: GetWorkspacesByWorkspaceIdTasksById tags: - Tasks summary: Get tasks by workspaceId + id security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchWorkspacesByWorkspaceIdTasksById tags: - Tasks summary: Update tasks by workspaceId + id security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteWorkspacesByWorkspaceIdTasksById tags: - Tasks summary: Delete tasks by workspaceId + id security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/teams: get: operationId: GetWorkspacesByWorkspaceIdTeams tags: - Teams summary: Get teams by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. post: operationId: PostWorkspacesByWorkspaceIdTeams tags: - Teams summary: Create teams by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/teams/{teamId}: get: operationId: GetWorkspacesByWorkspaceIdTeamsByTeamId tags: - Teams summary: Get teams by workspaceId + teamId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: teamId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchWorkspacesByWorkspaceIdTeamsByTeamId tags: - Teams summary: Update teams by workspaceId + teamId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: teamId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteWorkspacesByWorkspaceIdTeamsByTeamId tags: - Teams summary: Delete teams by workspaceId + teamId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: teamId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/teams/{teamId}/members: post: operationId: PostWorkspacesByWorkspaceIdTeamsByTeamIdMembers tags: - Teams summary: Create teams by workspaceId + teamId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: teamId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/teams/{teamId}/members/{userId}: delete: operationId: DeleteWorkspacesByWorkspaceIdTeamsByTeamIdMembersByUserId tags: - Teams summary: Delete teams by workspaceId + teamId + userId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: teamId in: path required: true schema: type: string - name: userId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/templates: get: operationId: GetWorkspacesByWorkspaceIdTemplates tags: - Templates summary: List workspace templates security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/webhooks: post: operationId: PostWorkspacesByWorkspaceIdWebhooks tags: - Webhooks summary: Create webhooks by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "201": description: The created resource. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. get: operationId: GetWorkspacesByWorkspaceIdWebhooks tags: - Webhooks summary: Get webhooks by workspaceId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/webhooks/{webhookId}: get: operationId: GetWorkspacesByWorkspaceIdWebhooksByWebhookId tags: - Webhooks summary: Get webhooks by workspaceId + webhookId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. patch: operationId: PatchWorkspacesByWorkspaceIdWebhooksByWebhookId tags: - Webhooks summary: Update webhooks by workspaceId + webhookId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "409": $ref: "#/components/responses/Err409" description: CONFLICT — duplicate or state conflict. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. delete: operationId: DeleteWorkspacesByWorkspaceIdWebhooksByWebhookId tags: - Webhooks summary: Delete webhooks by workspaceId + webhookId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries: get: operationId: GetWorkspacesByWorkspaceIdWebhooksByWebhookIdDeliveries tags: - Webhooks summary: Get webhooks by workspaceId + webhookId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries/{deliveryId}: get: operationId: GetWorkspacesByWorkspaceIdWebhooksByWebhookIdDeliveriesByDeliveryId tags: - Webhooks summary: Get webhooks by workspaceId + webhookId + deliveryId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - name: deliveryId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" responses: "200": description: OK. content: application/json: schema: type: object "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries/{deliveryId}/retry: post: operationId: PostWorkspacesByWorkspaceIdWebhooksByWebhookIdDeliveriesByDeliveryIdRetry tags: - Webhooks summary: Create webhooks by workspaceId + webhookId + deliveryId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - name: deliveryId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/webhooks/{webhookId}/resubmit: post: operationId: PostWorkspacesByWorkspaceIdWebhooksByWebhookIdResubmit tags: - Webhooks summary: Create webhooks by workspaceId + webhookId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/webhooks/{webhookId}/rotate-secret: post: operationId: PostWorkspacesByWorkspaceIdWebhooksByWebhookIdRotateSecret tags: - Webhooks summary: Create webhooks by workspaceId + webhookId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. /workspaces/{workspaceId}/webhooks/{webhookId}/test: post: operationId: PostWorkspacesByWorkspaceIdWebhooksByWebhookIdTest tags: - Webhooks summary: Create webhooks by workspaceId + webhookId security: - bearerAuth: [] parameters: - name: workspaceId in: path required: true schema: type: string - name: webhookId in: path required: true schema: type: string - $ref: "#/components/parameters/FactoryWorkspace" - $ref: "#/components/parameters/IdempotencyKey" responses: "200": description: OK. content: application/json: schema: type: object "400": $ref: "#/components/responses/Err400" description: VALIDATION_ERROR — request validation failed. "401": $ref: "#/components/responses/Err401" description: UNAUTHORIZED — missing/invalid credentials. "403": $ref: "#/components/responses/Err403" description: FORBIDDEN — insufficient permission or API-key scope (SCOPE_DENIED). "404": $ref: "#/components/responses/Err404" description: NOT_FOUND — resource does not exist for this caller. "429": $ref: "#/components/responses/Err429" description: RATE_LIMITED — rate limit exceeded (see X-RateLimit-* headers). "500": $ref: "#/components/responses/Err500" description: INTERNAL_ERROR — unexpected server error. components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT or API key (fk_…) description: User session JWT, or an `fk_` API key (the key acts as its workspace; scopes READ/WRITE/ADMIN). parameters: FactoryWorkspace: name: X-Factory-Workspace in: header required: false description: "Optional workspace context. For API keys: if present, MUST equal the key's own workspace (else 403 workspace_mismatch). For users: if the JWT covers several workspaces, selects the active one (must be a membership). The path's `:workspaceId` segment is the authoritative selector on workspace-scoped routes." schema: type: string IdempotencyKey: name: Idempotency-Key in: header required: false description: "Client-chosen unique key (≤ 128 chars). A repeated key within 24 h replays the stored 2xx response (header `Idempotency-Replayed: true`) instead of re-executing." schema: type: string maxLength: 128 schemas: ErrorDetail: type: object properties: reason: type: string description: Machine-readable reason (e.g. api_key_scope_write, workspace_mismatch, requires_user_credentials). field: type: string description: "Validation: the offending field." issue: type: string description: "Validation: the issue (required, already_exists, …)." ErrorResponse: type: object required: - error properties: error: type: object required: - code - message - requestId properties: code: type: string description: Canonical error code (VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, UNPROCESSABLE_ENTITY, PAYLOAD_TOO_LARGE, RATE_LIMITED, INTERNAL_ERROR, …). message: type: string details: type: array items: $ref: "#/components/schemas/ErrorDetail" requestId: type: string responses: Err400: description: Validation failed. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" Err401: description: Unauthenticated. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" Err403: description: Forbidden (permission / API-key scope / workspace mismatch). content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" Err404: description: Not found. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" Err409: description: Conflict. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" Err422: description: Unprocessable (domain validation). content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" Err429: description: Rate limited. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" Err500: description: Internal error. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse"