The State of Docs Survey 2025. Use your voice to prove why docs matter:
Take the survey
Product
PricingLog inSign up

Revisions

Review and manage content revisions.

Get a specific revision in a space

get
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

revisionIdstringrequired

The unique id of the revision

Query parameters
metadataboolean · default: trueoptional

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

computedboolean · default: trueoptional

If false is passed, content will not be computed

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/revisions/{revisionId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "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": [
    {
      "id": "text",
      "title": "text",
      "document": "text",
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ],
  "createdAt": "2025-04-03T20:33:51.727Z",
  "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"
}

OK

Return the semantic changes between a revision and its parent.

get
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

revisionIdstringrequired

The unique id of the revision

Query parameters
metadataboolean · default: trueoptional

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

computedboolean · default: trueoptional

If false is passed, content will not be computed

limitnumber · default: 10optional

Limit the number of changes returned

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/revisions/{revisionId}/changes' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "changes": [
    {
      "type": "page_created",
      "page": {
        "id": "text",
        "type": "document",
        "title": "text",
        "path": "text"
      }
    }
  ],
  "more": 1
}

OK

List all pages in a revision

get
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

revisionIdstringrequired

The unique id of the revision

Query parameters
metadataboolean · default: trueoptional

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

computedboolean · default: trueoptional

If false is passed, content will not be computed

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/revisions/{revisionId}/pages' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-04-03T20:33:51.727Z",
      "updatedAt": "2025-04-03T20:33:51.727Z",
      "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"
    }
  ]
}

OK

List all files in a revision

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

metadataboolean · default: trueoptional

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

computedboolean · default: trueoptional

If false is passed, content will not be computed

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/revisions/{revisionId}/files' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "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"
      }
    }
  ]
}

OK

Get a file in a revision 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
metadataboolean · default: trueoptional

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

computedboolean · default: trueoptional

If false is passed, content will not be computed

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/revisions/{revisionId}/files/{fileId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "text",
  "name": "text",
  "contentType": "text",
  "downloadURL": "text",
  "size": 1,
  "dimensions": {
    "width": 1,
    "height": 1
  },
  "git": {
    "oid": "text",
    "path": "text"
  }
}

OK

Get a page by its ID 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
formatstring · enumoptional

Output format for the content.

Available options:
metadataboolean · default: trueoptional

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

computedboolean · default: trueoptional

If false is passed, content will not be computed

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/revisions/{revisionId}/page/{pageId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-04-03T20:33:51.727Z",
  "updatedAt": "2025-04-03T20:33:51.727Z",
  "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"
}

OK

Get a page by its path in a revision.

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.

Available options:
metadataboolean · default: trueoptional

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

computedboolean · default: trueoptional

If false is passed, content will not be computed

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/revisions/{revisionId}/path/{pagePath}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-04-03T20:33:51.727Z",
  "updatedAt": "2025-04-03T20:33:51.727Z",
  "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"
}

OK

Get reusable content in a revision 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
metadataboolean · default: trueoptional

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

computedboolean · default: trueoptional

If false is passed, content will not be computed

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/revisions/{revisionId}/reusable-contents/{reusableContentId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "text",
  "title": "text",
  "document": "text",
  "git": {
    "oid": "text",
    "path": "text"
  }
}

OK

Was this helpful?