Documents endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/projects/{projectId}/docs

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
spaceId	query	string (uuid)	no
elementId	query	string (uuid)	no
draftId	query	string (uuid)	no
type	query	string	no
cursor	query	string	no
limit	query	integer (int32) or string (int32)	no

Status	Meaning	Body
200	OK	none

POST /api/projects/{projectId}/docs

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): CreateDocRequest

Field	Type	Required	Notes
id	string (uuid)	yes
title	string	yes
spaceId	string (uuid) or null	no
elementId	string (uuid) or null	no
draftId	string (uuid) or null	no
type	string or null	no

Status	Meaning	Body
200	OK	none

GET /api/projects/{projectId}/docs/{docId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
docId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	none

PATCH /api/projects/{projectId}/docs/{docId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
docId	path	string (uuid)	yes

Request body (application/json): UpdateDocRequest

Field	Type	Required	Notes
title	string or null	yes
content	string or null	yes
spaceId	string (uuid) or null	yes
elementId	string (uuid) or null	yes
setSpaceId	boolean	no	default false
setElementId	boolean	no	default false
draftId	string (uuid) or null	no
type	string or null	no
setDraftId	boolean	no	default false
setType	boolean	no	default false

Status	Meaning	Body
200	OK	none

DELETE /api/projects/{projectId}/docs/{docId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
docId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	none