Error
A valid request URL is required to generate request examples{
"results": {
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"ownerUserUuid": "<string>",
"createdByUserUuid": "<string>",
"description": "<string>",
"slug": "<string>",
"name": "<string>",
"spaceUuid": "<string>",
"organizationUuid": "<string>",
"projectUuid": "<string>",
"documentUuid": "<string>",
"pinnedListUuid": "<string>",
"version": {
"createdAt": "2023-11-07T05:31:56Z",
"createdByUserUuid": "<string>",
"content": {
"charts": {},
"markdown": "<string>"
},
"schemaVersion": 2,
"versionNumber": 123,
"versionUuid": "<string>"
},
"owner": {
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
},
"createdBy": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"avatarGradient": "<string>"
},
"directAccessRoles": [
"viewer"
],
"access": [
{
"hasDirectAccess": true,
"role": "viewer",
"userUuid": "<string>",
"grantSourceUuid": "<string>",
"grantedVia": "app",
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer"
}
]
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Documents
Post apiv1projects documents
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
documents
Error
A valid request URL is required to generate request examples{
"results": {
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"ownerUserUuid": "<string>",
"createdByUserUuid": "<string>",
"description": "<string>",
"slug": "<string>",
"name": "<string>",
"spaceUuid": "<string>",
"organizationUuid": "<string>",
"projectUuid": "<string>",
"documentUuid": "<string>",
"pinnedListUuid": "<string>",
"version": {
"createdAt": "2023-11-07T05:31:56Z",
"createdByUserUuid": "<string>",
"content": {
"charts": {},
"markdown": "<string>"
},
"schemaVersion": 2,
"versionNumber": 123,
"versionUuid": "<string>"
},
"owner": {
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
},
"createdBy": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"avatarGradient": "<string>"
},
"directAccessRoles": [
"viewer"
],
"access": [
{
"hasDirectAccess": true,
"role": "viewer",
"userUuid": "<string>",
"grantSourceUuid": "<string>",
"grantedVia": "app",
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer"
}
]
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Path Parameters
Body
application/json
Markdown with a <document-chart id="…"> block wherever a chart sits, and
the charts those blocks reference. On writes, ids that are not c<n> are
temporary keys the server replaces with the next free id.
Show child attributes
Show child attributes
Available options:
2 Organization member to assign as owner; omitted or null leaves the Document unowned.
Omit to create a personal Document, visible only to its creator and admins.
Was this page helpful?