Computed content

Manage content generated from data and templates.

Generate a document for a page in a computed content.

post

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

schemastring · enumoptional

Version of the schema used for the document.

Available options:

Body

sourceone ofrequired

Parameters for a computed content managed by an integration

seedstringrequired

Seed to use for the generation of IDs.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/content/computed/document' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": {
      "type": "builtin:openapi",
      "dependencies": {
        "spec": {
          "ref": {
            "kind": "openapi",
            "spec": "text"
          }
        }
      },
      "props": {
        "doc": "models"
      }
    },
    "seed": "text"
  }'

200

default

200

{
  "object": "document",
  "data": {
    "schemaVersion": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "nodes": [
    {
      "object": "block",
      "type": "paragraph",
      "key": "text",
      "nodes": [
        {
          "object": "inline",
          "type": "link",
          "key": "text",
          "nodes": [
            {
              "object": "text",
              "key": "text",
              "leaves": [
                {
                  "object": "leaf",
                  "text": "text",
                  "marks": [
                    {
                      "object": "mark",
                      "type": "bold"
                    }
                  ]
                }
              ]
            }
          ],
          "data": {
            "ref": {
              "kind": "file",
              "file": "text"
            }
          },
          "isVoid": false
        }
      ],
      "isVoid": false,
      "data": {}
    }
  ]
}

Document computed

Get the computed content for a source in a computed content.

post

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Body

sourceone ofrequired

Parameters for a computed content managed by an integration

seedstringrequired

Seed to use for the generation of IDs.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/content/computed/revision' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": {
      "type": "builtin:openapi",
      "dependencies": {
        "spec": {
          "ref": {
            "kind": "openapi",
            "spec": "text"
          }
        }
      },
      "props": {
        "models": true
      }
    },
    "seed": "text"
  }'

200

default

200

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-04-03T19:42:09.842Z",
      "updatedAt": "2025-04-03T19:42:09.842Z",
      "markdown": "text",
      "kind": "sheet",
      "type": "document",
      "urls": {
        "app": "https://example.com"
      },
      "slug": "text",
      "path": "text",
      "description": "text",
      "documentId": "text",
      "pages": [
        "[Circular Reference]"
      ],
      "git": {
        "oid": "text",
        "path": "text"
      },
      "layout": {
        "cover": true,
        "coverSize": "hero",
        "title": true,
        "description": true,
        "tableOfContents": true,
        "outline": true,
        "pagination": true
      },
      "cover": {
        "ref": {
          "kind": "file",
          "file": "text"
        },
        "yPos": 1
      },
      "hidden": true,
      "noIndex": true,
      "noRobotsIndex": true,
      "computed": {
        "type": "builtin:openapi",
        "dependencies": {
          "spec": {
            "ref": {
              "kind": "openapi",
              "spec": "text"
            }
          }
        },
        "props": {
          "doc": "models"
        }
      },
      "computedSeed": "text"
    }
  ],
  "files": [
    {
      "id": "text",
      "name": "text",
      "contentType": "text",
      "downloadURL": "text",
      "size": 1,
      "dimensions": {
        "width": 1,
        "height": 1
      },
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ]
}

Computed pages and files