Workshop API and MCP Surfaces

OpenAPI contract for Workshop HTTP API, public media routes, bootstrap/OAuth endpoints, direct MCP HTTP gateway routes, and the streamable HTTP MCP transport. Generated from the current server route surface on 2026-07-09.

Version 1.0.0 Base URL: https://demo.ws.video

Authentication

ApiKeyAuth

Type: API Key (in header)

BearerAuth

Type: HTTP bearer

OAuth2ClientCredentials

Type: OAuth 2.0

Public

GET/health

Public health check

Responses

200OK

Public Media

GET/assets/{id}

Read uploaded asset media by ID

Parameters

NameLocationTypeDescription
id*pathstring

Responses

200Binary response
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/sources/{id}/media

Read source media by ID

Parameters

NameLocationTypeDescription
id*pathstring

Responses

200Binary response
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/sources/{id}/thumbnails/{thumbnailId}

Read generated source thumbnail

Parameters

NameLocationTypeDescription
id*pathstring
thumbnailId*pathstring

Responses

200Binary response
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

OAuth

GET/.well-known/oauth-protected-resource

OAuth protected-resource metadata

Responses

200OK
GET/.well-known/oauth-protected-resource/{resourcePath}

OAuth protected-resource metadata for a resource path

Parameters

NameLocationTypeDescription
resourcePath*pathstring

Responses

200OK
GET/.well-known/oauth-authorization-server

OAuth authorization-server metadata

Responses

200OK
POST/oauth/token

Issue an OAuth client-credentials bearer token

Request Body

Content-Type: application/x-www-form-urlencoded

Responses

200OK
400Bad request
401Authentication required
503Internal server error

Bootstrap

GET/bootstrap/status

Read bootstrap availability and mode

Responses

200OK
POST/bootstrap/orgs

Provision an org and initial API principal

Parameters

NameLocationTypeDescription
x-bootstrap-secretheaderstringRequired when bootstrap secret mode is enabled.

Request Body

Content-Type: application/json

Responses

201OK
400Bad request
403Forbidden
409Bad request
501Internal server error

Health

GET/api/health

Authenticated health and capability status

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK

Principals

GET/api/principals

List API principals for current org

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/principals

Create an API principal

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/session-token

Mint a short-lived Workshop bearer token

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
DELETE/api/principals/{id}

Disable an API principal

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

204No content
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

Compile

POST/api/compile

Compile .ws source into a RenderGraph

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/compile/file

Compile uploaded .ws file

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: multipart/form-data

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/validate

Validate a RenderGraph

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

Render

POST/api/render

Queue render from .ws source or RenderGraph

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
x-render-engineheaderstringOptional render engine override.
x-idempotency-keyheaderstringOptional idempotency key for render enqueue requests.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
409Bad request
422Validation or compilation failed
500Internal server error
POST/api/render/file

Queue render from uploaded .ws file

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
x-render-engineheaderstringOptional render engine override.
x-idempotency-keyheaderstringOptional idempotency key for render enqueue requests.

Request Body

Content-Type: multipart/form-data

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/render/{id}

Get render job status

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/video/{id}

Download completed rendered MP4

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200Binary response
400Bad request
401Authentication required
403Forbidden
404Not found
409Bad request
422Validation or compilation failed
500Internal server error
GET/api/queue

Read render queue status

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK

Assets

POST/api/assets

Upload one or more media/font/document assets

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: multipart/form-data

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

Sources

POST/api/sources/upload

Upload a long-form source video or audio file

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: multipart/form-data

Responses

200OK
201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/sources

List sources

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
tagquerystring
originquerystring
statusquerystring
sortByquerystring
orderquerystring
limitqueryinteger
offsetqueryinteger

Responses

200OK
POST/api/sources

Register a source from asset ID or URL

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/sources/{id}

Get source

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
DELETE/api/sources/{id}

Delete source

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

204No content
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/sources/{id}/preprocess

Get source preprocessing status

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/sources/{id}/preprocess

Start source preprocessing

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

202OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

Clips

POST/api/clips/candidates

Generate clip candidates from a source

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/clips/candidates/refine

Refine a clip candidate or selection window

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/clips/draft

Create an in-memory .ws clip draft

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/clips/documents

Create and persist a clip document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/clips/documents/{id}/redraft

Redraft an existing clip document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/clips/documents/{id}/export

Export clip document as .ws text or JSON

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring
formatquerystring
includeVersionsqueryboolean

Responses

200Exported clip document
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

Templates

GET/api/templates

List templates

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK
POST/api/templates

Register a template

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/templates/{name}

Get template

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
name*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
PUT/api/templates/{name}

Update template

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
name*pathstring

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
DELETE/api/templates/{name}

Delete template

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
name*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/render/template

Render from template variables

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
x-render-engineheaderstringOptional render engine override.
x-idempotency-keyheaderstringOptional idempotency key for render enqueue requests.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/render/batch

Queue a batch render from template variables

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/batch/{id}

Get batch status

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

Themes

GET/api/themes

List ThemePacks

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK
POST/api/themes

Register a ThemePack

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/themes/{name}

Get ThemePack

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
name*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
PUT/api/themes/{name}

Update ThemePack

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
name*pathstring

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
DELETE/api/themes/{name}

Delete ThemePack

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
name*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/themes/validate

Validate ThemePack without saving

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK

Moods

GET/api/moods

List built-in moods and aliases

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK
GET/api/moods/{name}

Get mood profile

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
name*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

Documents

GET/api/documents

List documents

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
tagquerystring
sortByquerystring
orderquerystring
limitqueryinteger
offsetqueryinteger

Responses

200OK
POST/api/documents

Create document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/documents/{id}

Get document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
PUT/api/documents/{id}

Update document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
DELETE/api/documents/{id}

Delete document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

204No content
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/documents/{id}/versions

List document versions

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/documents/{id}/render

Render document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring
x-render-engineheaderstringOptional render engine override.
x-idempotency-keyheaderstringOptional idempotency key for render enqueue requests.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/documents/{id}/edit

Apply structured edits to document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
423Forbidden
500Internal server error
GET/api/documents/{id}/lock

Get document lock status

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200OK
POST/api/documents/{id}/lock

Acquire document edit lock

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
409Bad request
422Validation or compilation failed
500Internal server error
DELETE/api/documents/{id}/lock

Release document edit lock

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring
x-lock-token*headerstring

Responses

204No content
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/documents/{id}/annotations

List document annotations

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring
typequerystring

Responses

200OK
POST/api/documents/{id}/annotations

Add document annotation

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Request Body

Content-Type: application/json

Responses

201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
DELETE/api/documents/{id}/annotations/{annotationId}

Delete document annotation

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring
annotationId*pathstring

Responses

204No content
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

Authoring

POST/api/prompt/generate

Generate external video model scene prompts from .ws

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
501Internal server error
502Internal server error
POST/api/author

Author .ws from natural language prompt

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
501Internal server error
502Internal server error

MCP Transport

GET/api/mcp

MCP streamable HTTP transport GET

Requires API key or bearer token. Demo authentication is rejected for remote MCP sessions.

Parameters

NameLocationTypeDescription
mcp-session-idheaderstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/mcp

MCP streamable HTTP transport POST

Use JSON-RPC initialize, tools/list, and tools/call over this endpoint.

Parameters

NameLocationTypeDescription
mcp-session-idheaderstring

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
DELETE/api/mcp

Close MCP streamable HTTP session

Parameters

NameLocationTypeDescription
mcp-session-idheaderstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error

MCP HTTP Gateway

GET/api/mcp/manifest

Get MCP HTTP gateway manifest

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK
GET/api/mcp/tools

List HTTP gateway tool definitions

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK
POST/api/mcp/compile

MCP wrapper: compile .ws

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/mcp/scene

MCP wrapper: inspect a RenderGraph scene

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/mcp/tokens

MCP wrapper: extract mood tokens and film metadata

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/mcp/moods

MCP wrapper: list moods

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK
GET/api/mcp/templates

MCP wrapper: list templates

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Responses

200OK
POST/api/mcp/prompt

MCP wrapper: generate external video prompts

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
POST/api/mcp/documents/save

MCP wrapper: create or update document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.

Request Body

Content-Type: application/json

Responses

200OK
201OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
GET/api/mcp/documents

MCP wrapper: list documents

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
tagquerystring
sortByquerystring
orderquerystring
limitqueryinteger
offsetqueryinteger

Responses

200OK
GET/api/mcp/documents/{id}

MCP wrapper: get document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

200OK
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error
DELETE/api/mcp/documents/{id}

MCP wrapper: delete document

Parameters

NameLocationTypeDescription
x-org-idheaderstringOptional org override for API-key authenticated requests when allowed.
id*pathstring

Responses

204No content
400Bad request
401Authentication required
403Forbidden
404Not found
422Validation or compilation failed
500Internal server error