Space content

Import, export, and search content in a space.

Handle your space content programmatically by creating, updating, or listing pages and files. Ideal for bulk operations or synchronizing with external systems.

Search content in a space

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

querystring · max: 512Required

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/search HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "title": "text",
      "path": "text",
      "sections": [
        {
          "id": "text",
          "title": "text",
          "path": "text",
          "body": "text",
          "urls": {
            "app": "https://example.com"
          }
        }
      ],
      "ancestors": [
        {
          "title": "text"
        }
      ],
      "urls": {
        "app": "https://example.com"
      }
    }
  ]
}

Get a space current revision

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseone of

all ofOptional

or

all ofOptional

or

all ofOptional

or

all ofOptional

or

all ofOptional

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "object": "revision",
  "id": "text",
  "parents": [
    "text"
  ],
  "pages": [
    "[Circular Reference]"
  ],
  "files": [
    {
      "id": "text",
      "name": "text",
      "contentType": "text",
      "downloadURL": "text",
      "size": 1,
      "dimensions": {
        "width": 1,
        "height": 1
      },
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ],
  "reusableContents": [
    {
      "0": "[",
      "1": "C",
      "2": "i",
      "3": "r",
      "4": "c",
      "5": "u",
      "6": "l",
      "7": "a",
      "8": "r",
      "9": " ",
      "10": "R",
      "11": "e",
      "12": "f",
      "13": "e",
      "14": "r",
      "15": "e",
      "16": "n",
      "17": "c",
      "18": "e",
      "19": "]",
      "id": "text",
      "title": "text",
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ],
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "createdAt": "2025-11-16T19:04:30.239Z",
  "git": {
    "oid": "text",
    "message": "text",
    "createdByGitBook": true,
    "url": "text",
    "ref": "text"
  },
  "urls": {
    "app": "https://example.com",
    "published": "https://example.com",
    "public": "https://example.com"
  },
  "type": "edits"
}

Apply a template to a space.

post

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Body

all ofOptional

Responses

201

Template applied to space.

post

HTTPcURLJavaScriptPython

POST /v1/spaces/{spaceId}/content/template HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "id": "text",
  "params": {
    "contentRefs": {
      "ANY_ADDITIONAL_PROPERTY": {
        "kind": "file",
        "file": "text"
      }
    }
  },
  "changeRequestId": "text"
}

201

Template applied to space.

No content

List all space pages

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/pages HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-11-16T19:04:30.239Z",
      "updatedAt": "2025-11-16T19:04:30.239Z",
      "markdown": "text",
      "type": "document",
      "urls": {
        "app": "https://example.com"
      },
      "slug": "text",
      "path": "text",
      "description": "text",
      "pages": [
        "[Circular Reference]"
      ],
      "git": {
        "oid": "text",
        "path": "text"
      },
      "layout": {
        "width": "default",
        "cover": true,
        "coverSize": "hero",
        "title": true,
        "description": true,
        "tableOfContents": true,
        "outline": true,
        "pagination": true,
        "metadata": true
      },
      "cover": {
        "ref": {
          "kind": "file",
          "file": "text"
        },
        "refDark": {
          "kind": "file",
          "file": "text"
        },
        "yPos": 0,
        "height": 240
      },
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "hidden": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "metaLinks": {
        "canonical": {
          "kind": "page",
          "page": "text",
          "space": "text"
        },
        "alternates": [
          {
            "kind": "page",
            "page": "text",
            "space": "text"
          }
        ]
      },
      "computed": {
        "type": "builtin:openapi",
        "dependencies": {
          "spec": {
            "ref": {
              "kind": "openapi",
              "spec": "text"
            }
          }
        },
        "props": {
          "doc": "models"
        }
      },
      "computedSeed": "text"
    }
  ]
}

List all space files

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/files HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "contentType": "text",
      "downloadURL": "text",
      "size": 1,
      "dimensions": {
        "width": 1,
        "height": 1
      },
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ]
}

Get a space file by its ID

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

fileIdstringRequired

The unique id of the file

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/files/{fileId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "name": "text",
  "contentType": "text",
  "downloadURL": "text",
  "size": 1,
  "dimensions": {
    "width": 1,
    "height": 1
  },
  "git": {
    "oid": "text",
    "path": "text"
  }
}

List all space file backlink locations

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

fileIdstringRequired

The unique id of the file

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/files/{fileId}/backlinks HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2025-11-16T19:04:30.239Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "billing": {
          "interval": "monthly",
          "endDate": "2025-11-16T19:04:30.239Z",
          "hasPaymentFailed": true,
          "isScheduledToCancel": true,
          "pricing": {
            "members": {
              "plus_2024": {
                "monthly": 1,
                "yearly": 1
              },
              "pro_2024": {
                "monthly": 1,
                "yearly": 1
              }
            },
            "sites": {
              "premium": {
                "monthly": 1,
                "yearly": 1
              },
              "ultimate": {
                "monthly": 1,
                "yearly": 1
              }
            }
          },
          "usageAddons": {
            "ANY_ADDITIONAL_PROPERTY": {
              "enabled": true
            }
          }
        },
        "mergeRules": {
          "type": "rules",
          "rules": [
            {
              "rule": "require_specific_reviewers",
              "users": [
                "text"
              ]
            }
          ]
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "count": 1,
          "endDate": "2025-11-16T19:04:30.239Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "source": "backoffice",
          "reason": "text"
        },
        "internal_billingMigration": {
          "deadline": "2025-11-16T19:04:30.239Z",
          "discountPercent": 1,
          "discountEndDate": "2025-11-16T19:04:30.239Z"
        },
        "permissions": {
          "view": true,
          "admin": true,
          "ownTeam": true,
          "createContent": true,
          "createOpenAPISpec": true,
          "ingestConversations": true,
          "viewBilling": true,
          "listMembers": true,
          "listTeams": true,
          "listIntegrations": true,
          "listInstallations": true,
          "installIntegration": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2025-11-16T19:04:30.239Z",
        "updatedAt": "2025-11-16T19:04:30.239Z",
        "deletedAt": "2025-11-16T19:04:30.239Z",
        "editMode": "live",
        "mergeRules": {
          "type": "inherit"
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com",
          "public": "https://example.com",
          "icon": "https://example.com"
        },
        "organization": "text",
        "parent": "text",
        "language": "en",
        "gitSync": {
          "repoName": "text",
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2025-11-16T19:04:30.239Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "view": true,
          "access": true,
          "admin": true,
          "viewInviteLinks": true,
          "edit": true,
          "triggerGitSync": true,
          "comment": true,
          "merge": true,
          "review": true,
          "installIntegration": true
        }
      },
      "versionContext": {
        "type": "revision",
        "revision": "[Circular Reference]"
      },
      "file": {
        "id": "text",
        "name": "text",
        "contentType": "text",
        "downloadURL": "text",
        "size": 1,
        "dimensions": {
          "width": 1,
          "height": 1
        },
        "git": {
          "oid": "text",
          "path": "text"
        }
      }
    }
  ]
}

Get a space page by its ID

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

pageIdstringRequired

The unique id of the page

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

evaluatedone ofOptional

Controls whether the document should be evaluated.

• When set to true, the entire document will be evaluated.
• When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseone of

all ofOptional

and

one ofOptional

or

or

object · EmptyOptional

and

and

one ofOptional

or

or

all ofOptional

or

all ofOptional

or

all ofOptional

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/page/{pageId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-11-16T19:04:30.239Z",
  "updatedAt": "2025-11-16T19:04:30.239Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "pages": [
    "[Circular Reference]"
  ],
  "git": {
    "oid": "text",
    "path": "text"
  },
  "layout": {
    "width": "default",
    "cover": true,
    "coverSize": "hero",
    "title": true,
    "description": true,
    "tableOfContents": true,
    "outline": true,
    "pagination": true,
    "metadata": true
  },
  "cover": {
    "ref": {
      "kind": "file",
      "file": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text"
    },
    "yPos": 0,
    "height": 240
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "hidden": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "metaLinks": {
    "canonical": {
      "kind": "page",
      "page": "text",
      "space": "text"
    },
    "alternates": [
      {
        "kind": "page",
        "page": "text",
        "space": "text"
      }
    ]
  },
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

List all space page links

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

pageIdstringRequired

The unique id of the page

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

statusstring · enumOptional

Text to display to represent the reference. Possible values include:

• ok - No problems detected for this content reference.
• broken - The target does not exist in the revision.
• in-app - The target is a URL link pointing to an internal location in the app.

Possible values:

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/page/{pageId}/links HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "stats": {
    "total": 1,
    "broken": {
      "total": 1,
      "changeRequest": 1
    }
  },
  "items": [
    {
      "status": "ok",
      "relation": "reference",
      "targetReference": {
        "kind": "file",
        "organization": {
          "object": "organization",
          "id": "text",
          "title": "text",
          "createdAt": "2025-11-16T19:04:30.239Z",
          "emailDomains": [
            "text"
          ],
          "hostname": "text",
          "type": "business",
          "useCase": "internalDocs",
          "communityType": "nonProfit",
          "defaultRole": "admin",
          "defaultContent": {
            "type": "site",
            "site": "text"
          },
          "sso": true,
          "ai": true,
          "inviteLinks": true,
          "plan": "free_2024",
          "billing": {
            "interval": "monthly",
            "endDate": "2025-11-16T19:04:30.239Z",
            "hasPaymentFailed": true,
            "isScheduledToCancel": true,
            "pricing": {
              "members": {
                "plus_2024": {
                  "monthly": 1,
                  "yearly": 1
                },
                "pro_2024": {
                  "monthly": 1,
                  "yearly": 1
                }
              },
              "sites": {
                "premium": {
                  "monthly": 1,
                  "yearly": 1
                },
                "ultimate": {
                  "monthly": 1,
                  "yearly": 1
                }
              }
            },
            "usageAddons": {
              "ANY_ADDITIONAL_PROPERTY": {
                "enabled": true
              }
            }
          },
          "mergeRules": {
            "type": "rules",
            "rules": [
              {
                "rule": "require_specific_reviewers",
                "users": [
                  "text"
                ]
              }
            ]
          },
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trial": {
            "status": "notapplicable",
            "count": 1,
            "endDate": "2025-11-16T19:04:30.239Z",
            "decision": "downgrade"
          },
          "customHostname": "text",
          "blocked": {
            "source": "backoffice",
            "reason": "text"
          },
          "internal_billingMigration": {
            "deadline": "2025-11-16T19:04:30.239Z",
            "discountPercent": 1,
            "discountEndDate": "2025-11-16T19:04:30.239Z"
          },
          "permissions": {
            "view": true,
            "admin": true,
            "ownTeam": true,
            "createContent": true,
            "createOpenAPISpec": true,
            "ingestConversations": true,
            "viewBilling": true,
            "listMembers": true,
            "listTeams": true,
            "listIntegrations": true,
            "listInstallations": true,
            "installIntegration": true
          }
        },
        "space": {
          "object": "space",
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "visibility": "public",
          "createdAt": "2025-11-16T19:04:30.239Z",
          "updatedAt": "2025-11-16T19:04:30.239Z",
          "deletedAt": "2025-11-16T19:04:30.239Z",
          "editMode": "live",
          "mergeRules": {
            "type": "inherit"
          },
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "published": "https://example.com",
            "public": "https://example.com",
            "icon": "https://example.com"
          },
          "organization": "text",
          "parent": "text",
          "language": "en",
          "gitSync": {
            "repoName": "text",
            "installationProvider": "github",
            "integration": "text",
            "url": "text",
            "updatedAt": "2025-11-16T19:04:30.239Z"
          },
          "visitorAuth": {
            "backend": "custom"
          },
          "revision": "text",
          "defaultLevel": "admin",
          "comments": 1,
          "changeRequests": 1,
          "changeRequestsOpen": 1,
          "changeRequestsDraft": 1,
          "permissions": {
            "view": true,
            "access": true,
            "admin": true,
            "viewInviteLinks": true,
            "edit": true,
            "triggerGitSync": true,
            "comment": true,
            "merge": true,
            "review": true,
            "installIntegration": true
          }
        },
        "versionContext": "[Circular Reference]",
        "file": {
          "id": "text",
          "name": "text",
          "contentType": "text",
          "downloadURL": "text",
          "size": 1,
          "dimensions": {
            "width": 1,
            "height": 1
          },
          "git": {
            "oid": "text",
            "path": "text"
          }
        }
      },
      "locationReferences": [
        {
          "kind": "file",
          "organization": {
            "object": "organization",
            "id": "text",
            "title": "text",
            "createdAt": "2025-11-16T19:04:30.239Z",
            "emailDomains": [
              "text"
            ],
            "hostname": "text",
            "type": "business",
            "useCase": "internalDocs",
            "communityType": "nonProfit",
            "defaultRole": "admin",
            "defaultContent": {
              "type": "site",
              "site": "text"
            },
            "sso": true,
            "ai": true,
            "inviteLinks": true,
            "plan": "free_2024",
            "billing": {
              "interval": "monthly",
              "endDate": "2025-11-16T19:04:30.239Z",
              "hasPaymentFailed": true,
              "isScheduledToCancel": true,
              "pricing": {
                "members": {
                  "plus_2024": {
                    "monthly": 1,
                    "yearly": 1
                  },
                  "pro_2024": {
                    "monthly": 1,
                    "yearly": 1
                  }
                },
                "sites": {
                  "premium": {
                    "monthly": 1,
                    "yearly": 1
                  },
                  "ultimate": {
                    "monthly": 1,
                    "yearly": 1
                  }
                }
              },
              "usageAddons": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "enabled": true
                }
              }
            },
            "mergeRules": {
              "type": "rules",
              "rules": [
                {
                  "rule": "require_specific_reviewers",
                  "users": [
                    "text"
                  ]
                }
              ]
            },
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trial": {
              "status": "notapplicable",
              "count": 1,
              "endDate": "2025-11-16T19:04:30.239Z",
              "decision": "downgrade"
            },
            "customHostname": "text",
            "blocked": {
              "source": "backoffice",
              "reason": "text"
            },
            "internal_billingMigration": {
              "deadline": "2025-11-16T19:04:30.239Z",
              "discountPercent": 1,
              "discountEndDate": "2025-11-16T19:04:30.239Z"
            },
            "permissions": {
              "view": true,
              "admin": true,
              "ownTeam": true,
              "createContent": true,
              "createOpenAPISpec": true,
              "ingestConversations": true,
              "viewBilling": true,
              "listMembers": true,
              "listTeams": true,
              "listIntegrations": true,
              "listInstallations": true,
              "installIntegration": true
            }
          },
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2025-11-16T19:04:30.239Z",
            "updatedAt": "2025-11-16T19:04:30.239Z",
            "deletedAt": "2025-11-16T19:04:30.239Z",
            "editMode": "live",
            "mergeRules": {
              "type": "inherit"
            },
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "published": "https://example.com",
              "public": "https://example.com",
              "icon": "https://example.com"
            },
            "organization": "text",
            "parent": "text",
            "language": "en",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2025-11-16T19:04:30.239Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "view": true,
              "access": true,
              "admin": true,
              "viewInviteLinks": true,
              "edit": true,
              "triggerGitSync": true,
              "comment": true,
              "merge": true,
              "review": true,
              "installIntegration": true
            }
          },
          "versionContext": "[Circular Reference]",
          "file": {
            "id": "text",
            "name": "text",
            "contentType": "text",
            "downloadURL": "text",
            "size": 1,
            "dimensions": {
              "width": 1,
              "height": 1
            },
            "git": {
              "oid": "text",
              "path": "text"
            }
          }
        }
      ]
    }
  ]
}

List all space page backlink locations

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

pageIdstringRequired

The unique id of the page

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/page/{pageId}/backlinks HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2025-11-16T19:04:30.239Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "billing": {
          "interval": "monthly",
          "endDate": "2025-11-16T19:04:30.239Z",
          "hasPaymentFailed": true,
          "isScheduledToCancel": true,
          "pricing": {
            "members": {
              "plus_2024": {
                "monthly": 1,
                "yearly": 1
              },
              "pro_2024": {
                "monthly": 1,
                "yearly": 1
              }
            },
            "sites": {
              "premium": {
                "monthly": 1,
                "yearly": 1
              },
              "ultimate": {
                "monthly": 1,
                "yearly": 1
              }
            }
          },
          "usageAddons": {
            "ANY_ADDITIONAL_PROPERTY": {
              "enabled": true
            }
          }
        },
        "mergeRules": {
          "type": "rules",
          "rules": [
            {
              "rule": "require_specific_reviewers",
              "users": [
                "text"
              ]
            }
          ]
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "count": 1,
          "endDate": "2025-11-16T19:04:30.239Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "source": "backoffice",
          "reason": "text"
        },
        "internal_billingMigration": {
          "deadline": "2025-11-16T19:04:30.239Z",
          "discountPercent": 1,
          "discountEndDate": "2025-11-16T19:04:30.239Z"
        },
        "permissions": {
          "view": true,
          "admin": true,
          "ownTeam": true,
          "createContent": true,
          "createOpenAPISpec": true,
          "ingestConversations": true,
          "viewBilling": true,
          "listMembers": true,
          "listTeams": true,
          "listIntegrations": true,
          "listInstallations": true,
          "installIntegration": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2025-11-16T19:04:30.239Z",
        "updatedAt": "2025-11-16T19:04:30.239Z",
        "deletedAt": "2025-11-16T19:04:30.239Z",
        "editMode": "live",
        "mergeRules": {
          "type": "inherit"
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com",
          "public": "https://example.com",
          "icon": "https://example.com"
        },
        "organization": "text",
        "parent": "text",
        "language": "en",
        "gitSync": {
          "repoName": "text",
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2025-11-16T19:04:30.239Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "view": true,
          "access": true,
          "admin": true,
          "viewInviteLinks": true,
          "edit": true,
          "triggerGitSync": true,
          "comment": true,
          "merge": true,
          "review": true,
          "installIntegration": true
        }
      },
      "versionContext": {
        "type": "revision",
        "revision": "[Circular Reference]"
      },
      "file": {
        "id": "text",
        "name": "text",
        "contentType": "text",
        "downloadURL": "text",
        "size": 1,
        "dimensions": {
          "width": 1,
          "height": 1
        },
        "git": {
          "oid": "text",
          "path": "text"
        }
      }
    }
  ]
}

List all meta links for a space page

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

pageIdstringRequired

The unique id of the page

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/page/{pageId}/meta-links HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "canonical": {
    "kind": "page",
    "page": "text",
    "space": "text"
  },
  "alternates": [
    {
      "kind": "page",
      "page": "text",
      "space": "text"
    }
  ]
}

Get a space page by its path

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

pagePathstringRequired

The path of the page in the revision.

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

evaluatedone ofOptional

Controls whether the document should be evaluated.

• When set to true, the entire document will be evaluated.
• When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseone of

all ofOptional

and

one ofOptional

or

or

object · EmptyOptional

and

and

one ofOptional

or

or

all ofOptional

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/path/{pagePath} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-11-16T19:04:30.239Z",
  "updatedAt": "2025-11-16T19:04:30.239Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "pages": [
    "[Circular Reference]"
  ],
  "git": {
    "oid": "text",
    "path": "text"
  },
  "layout": {
    "width": "default",
    "cover": true,
    "coverSize": "hero",
    "title": true,
    "description": true,
    "tableOfContents": true,
    "outline": true,
    "pagination": true,
    "metadata": true
  },
  "cover": {
    "ref": {
      "kind": "file",
      "file": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text"
    },
    "yPos": 0,
    "height": 240
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "hidden": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "metaLinks": {
    "canonical": {
      "kind": "page",
      "page": "text",
      "space": "text"
    },
    "alternates": [
      {
        "kind": "page",
        "page": "text",
        "space": "text"
      }
    ]
  },
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

Get a space reusable content by its ID

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

reusableContentIdstringRequired

The unique id of the reusable content

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseall of

and

one ofOptional

or

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/reusable-contents/{reusableContentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "title": "text",
  "git": {
    "oid": "text",
    "path": "text"
  },
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

Get a space computed document

post

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

schemastring · enumOptional

Version of the schema used for the document.

Possible values:

Body

sourceone ofRequired

all ofOptional

and

or

or

seedstringRequired

Seed to use for the generation of IDs.

Responses

200

Document computed

application/json

post

HTTPcURLJavaScriptPython

POST /v1/spaces/{spaceId}/content/computed/document HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "source": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "seed": "text"
}

200

Document computed

{
  "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": {
        "align": "start"
      }
    }
  ]
}

Get a space computed revision

post

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Body

sourceone ofRequired

all ofOptional

and

or

or

seedstringRequired

Seed to use for the generation of IDs.

Responses

200

Computed pages and files

application/json

post

HTTPcURLJavaScriptPython

POST /v1/spaces/{spaceId}/content/computed/revision HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "source": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "models": true,
      "downloadLink": true
    }
  },
  "seed": "text"
}

200

Computed pages and files

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-11-16T19:04:30.239Z",
      "updatedAt": "2025-11-16T19:04:30.239Z",
      "markdown": "text",
      "type": "document",
      "urls": {
        "app": "https://example.com"
      },
      "slug": "text",
      "path": "text",
      "description": "text",
      "pages": [
        "[Circular Reference]"
      ],
      "git": {
        "oid": "text",
        "path": "text"
      },
      "layout": {
        "width": "default",
        "cover": true,
        "coverSize": "hero",
        "title": true,
        "description": true,
        "tableOfContents": true,
        "outline": true,
        "pagination": true,
        "metadata": true
      },
      "cover": {
        "ref": {
          "kind": "file",
          "file": "text"
        },
        "refDark": {
          "kind": "file",
          "file": "text"
        },
        "yPos": 0,
        "height": 240
      },
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "hidden": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "metaLinks": {
        "canonical": {
          "kind": "page",
          "page": "text",
          "space": "text"
        },
        "alternates": [
          {
            "kind": "page",
            "page": "text",
            "space": "text"
          }
        ]
      },
      "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"
      }
    }
  ],
  "reusableContents": [
    {
      "id": "text",
      "title": "text",
      "git": {
        "oid": "text",
        "path": "text"
      },
      "computed": {
        "type": "builtin:openapi",
        "dependencies": {
          "spec": {
            "ref": {
              "kind": "openapi",
              "spec": "text"
            }
          }
        },
        "props": {
          "doc": "models"
        }
      },
      "computedSeed": "text"
    }
  ]
}

Get a space document by its ID

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

documentIdstringRequired

ID of the document in the space

Query parameters

schemastring · enumOptional

Version of the schema used for the document.

Possible values:

Responses

200

Document

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/documents/{documentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Document

{
  "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": {
        "align": "start"
      }
    }
  ]
}

Get a space revision

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseone of

all ofOptional

or

all ofOptional

or

all ofOptional

or

all ofOptional

or

all ofOptional

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "object": "revision",
  "id": "text",
  "parents": [
    "text"
  ],
  "pages": [
    "[Circular Reference]"
  ],
  "files": [
    {
      "id": "text",
      "name": "text",
      "contentType": "text",
      "downloadURL": "text",
      "size": 1,
      "dimensions": {
        "width": 1,
        "height": 1
      },
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ],
  "reusableContents": [
    {
      "0": "[",
      "1": "C",
      "2": "i",
      "3": "r",
      "4": "c",
      "5": "u",
      "6": "l",
      "7": "a",
      "8": "r",
      "9": " ",
      "10": "R",
      "11": "e",
      "12": "f",
      "13": "e",
      "14": "r",
      "15": "e",
      "16": "n",
      "17": "c",
      "18": "e",
      "19": "]",
      "id": "text",
      "title": "text",
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ],
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "createdAt": "2025-11-16T19:04:30.239Z",
  "git": {
    "oid": "text",
    "message": "text",
    "createdByGitBook": true,
    "url": "text",
    "ref": "text"
  },
  "urls": {
    "app": "https://example.com",
    "published": "https://example.com",
    "public": "https://example.com"
  },
  "type": "edits"
}

Get space revision semantic changes

get

Return the semantic changes between a revision and its parent.

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

limitnumberOptional

Limit the number of changes returned

Default: 10

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/changes HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "mergedFrom": {
    "object": "change-request",
    "id": "text",
    "number": 1,
    "status": "draft",
    "subject": "text",
    "description": {
      "object": "document",
      "data": {
        "schemaVersion": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "nodes": [
        {
          "object": "block",
          "type": "paragraph",
          "key": "text",
          "nodes": "[Circular Reference]",
          "isVoid": false,
          "data": {
            "align": "start"
          }
        }
      ]
    },
    "createdBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    },
    "createdAt": "2025-11-16T19:04:30.239Z",
    "updatedAt": "2025-11-16T19:04:30.239Z",
    "space": "text",
    "revision": "text",
    "revisionInitial": "text",
    "revisionMergedAncestor": "text",
    "revisionMerged": "text",
    "comments": 1,
    "outdated": true,
    "conversationsIssuesCluster": "text",
    "urls": {
      "app": "https://example.com",
      "location": "https://example.com"
    }
  },
  "changes": [
    {
      "type": "page_created",
      "page": {
        "id": "text",
        "type": "document",
        "title": "text",
        "path": "text"
      }
    }
  ],
  "more": 1
}

List all pages in a space revision

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/pages HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-11-16T19:04:30.239Z",
      "updatedAt": "2025-11-16T19:04:30.239Z",
      "markdown": "text",
      "type": "document",
      "urls": {
        "app": "https://example.com"
      },
      "slug": "text",
      "path": "text",
      "description": "text",
      "pages": [
        "[Circular Reference]"
      ],
      "git": {
        "oid": "text",
        "path": "text"
      },
      "layout": {
        "width": "default",
        "cover": true,
        "coverSize": "hero",
        "title": true,
        "description": true,
        "tableOfContents": true,
        "outline": true,
        "pagination": true,
        "metadata": true
      },
      "cover": {
        "ref": {
          "kind": "file",
          "file": "text"
        },
        "refDark": {
          "kind": "file",
          "file": "text"
        },
        "yPos": 0,
        "height": 240
      },
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "hidden": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "metaLinks": {
        "canonical": {
          "kind": "page",
          "page": "text",
          "space": "text"
        },
        "alternates": [
          {
            "kind": "page",
            "page": "text",
            "space": "text"
          }
        ]
      },
      "computed": {
        "type": "builtin:openapi",
        "dependencies": {
          "spec": {
            "ref": {
              "kind": "openapi",
              "spec": "text"
            }
          }
        },
        "props": {
          "doc": "models"
        }
      },
      "computedSeed": "text"
    }
  ]
}

List all space revision files

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/files HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "contentType": "text",
      "downloadURL": "text",
      "size": 1,
      "dimensions": {
        "width": 1,
        "height": 1
      },
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ]
}

Get a space revision file by its ID

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

fileIdstringRequired

The unique id of the file

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/files/{fileId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "name": "text",
  "contentType": "text",
  "downloadURL": "text",
  "size": 1,
  "dimensions": {
    "width": 1,
    "height": 1
  },
  "git": {
    "oid": "text",
    "path": "text"
  }
}

Get a space revision page by its ID

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

pageIdstringRequired

The unique id of the page

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

evaluatedone ofOptional

Controls whether the document should be evaluated.

• When set to true, the entire document will be evaluated.
• When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseone of

all ofOptional

and

one ofOptional

or

or

object · EmptyOptional

and

and

one ofOptional

or

or

all ofOptional

or

all ofOptional

or

all ofOptional

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/page/{pageId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-11-16T19:04:30.239Z",
  "updatedAt": "2025-11-16T19:04:30.239Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "pages": [
    "[Circular Reference]"
  ],
  "git": {
    "oid": "text",
    "path": "text"
  },
  "layout": {
    "width": "default",
    "cover": true,
    "coverSize": "hero",
    "title": true,
    "description": true,
    "tableOfContents": true,
    "outline": true,
    "pagination": true,
    "metadata": true
  },
  "cover": {
    "ref": {
      "kind": "file",
      "file": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text"
    },
    "yPos": 0,
    "height": 240
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "hidden": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "metaLinks": {
    "canonical": {
      "kind": "page",
      "page": "text",
      "space": "text"
    },
    "alternates": [
      {
        "kind": "page",
        "page": "text",
        "space": "text"
      }
    ]
  },
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

Get the document of a page in a revision

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

pageIdstringRequired

The unique id of the page

Query parameters

evaluatedone ofOptional

Controls whether the document should be evaluated.

• When set to true, the entire document will be evaluated.
• When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/page/{pageId}/document HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "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": {
        "align": "start"
      }
    }
  ]
}

Get a space revision page by its path

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

pagePathstringRequired

The path of the page in the revision.

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

evaluatedone ofOptional

Controls whether the document should be evaluated.

• When set to true, the entire document will be evaluated.
• When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseone of

all ofOptional

and

one ofOptional

or

or

object · EmptyOptional

and

and

one ofOptional

or

or

all ofOptional

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/path/{pagePath} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-11-16T19:04:30.239Z",
  "updatedAt": "2025-11-16T19:04:30.239Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "pages": [
    "[Circular Reference]"
  ],
  "git": {
    "oid": "text",
    "path": "text"
  },
  "layout": {
    "width": "default",
    "cover": true,
    "coverSize": "hero",
    "title": true,
    "description": true,
    "tableOfContents": true,
    "outline": true,
    "pagination": true,
    "metadata": true
  },
  "cover": {
    "ref": {
      "kind": "file",
      "file": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text"
    },
    "yPos": 0,
    "height": 240
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "hidden": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "metaLinks": {
    "canonical": {
      "kind": "page",
      "page": "text",
      "space": "text"
    },
    "alternates": [
      {
        "kind": "page",
        "page": "text",
        "space": "text"
      }
    ]
  },
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

List all meta links for a revision page

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

pageIdstringRequired

The unique id of the page

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/page/{pageId}/meta-links HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "canonical": {
    "kind": "page",
    "page": "text",
    "space": "text"
  },
  "alternates": [
    {
      "kind": "page",
      "page": "text",
      "space": "text"
    }
  ]
}

Get a space revision reusable content by its ID

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

reusableContentIdstringRequired

The unique id of the reusable content

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

Responseall of

and

one ofOptional

or

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/reusable-contents/{reusableContentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "title": "text",
  "git": {
    "oid": "text",
    "path": "text"
  },
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

Get the document of a reusable content in a revision

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

revisionIdstringRequired

The unique id of the revision

reusableContentIdstringRequired

The unique id of the reusable content

Query parameters

evaluatedone ofOptional

Controls whether the document should be evaluated.

• When set to true, the entire document will be evaluated.
• When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/revisions/{revisionId}/reusable-contents/{reusableContentId}/document HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "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": {
        "align": "start"
      }
    }
  ]
}

Get a URL of the content of a space as PDF

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

onlybooleanOptional

Generate a PDF only for the provided page.

pagestringOptional

ID of a specific page to generate a PDF for.

Responses

200

URL of the PDF

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/pdf HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

URL of the PDF

{
  "url": "https://example.com"
}