Content

Content in GitBook is the entity for content on a page.

Get a space current revision

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

or

or

or

or

get

/spaces/{spaceId}/content

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": [
    {
      "id": "text",
      "title": "text",
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ],
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "createdAt": "2025-12-27T04:29:53.718Z",
  "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"
}

List all space files

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

get

/spaces/{spaceId}/content/files

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 page by its ID

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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:

dereferencedone ofOptional

Controls whether the document should be deferenced (eference to other content will be resolved and expanded).

• When set to true, the entire document will be deferenced
• When set to reusable-contents, only reusable contents will be deferenced.

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

or

or

or

get

/spaces/{spaceId}/content/page/{pageId}

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",
  "linkTitle": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-12-27T04:29:53.718Z",
  "updatedAt": "2025-12-27T04:29:53.718Z",
  "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",
      "space": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text",
      "space": "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 page by its path

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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:

dereferencedone ofOptional

Controls whether the document should be deferenced (eference to other content will be resolved and expanded).

• When set to true, the entire document will be deferenced
• When set to reusable-contents, only reusable contents will be deferenced.

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

or

get

/spaces/{spaceId}/content/path/{pagePath}

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",
  "linkTitle": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-12-27T04:29:53.718Z",
  "updatedAt": "2025-12-27T04:29:53.718Z",
  "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",
      "space": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text",
      "space": "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"
}

Import a Git repository

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

application/json

urlstringRequired

URL of the Git repository to import. It can contain basic auth credentials.

refstringRequired

Git ref to import in the format "refs/heads/main"

repoCacheIDstringOptional

Unique identifier to use to cache the Git repository across multiple operations.

repoTreeURLstringOptional

URL to use as a prefix for external file references.

repoCommitURLstringOptional

URL to use as a prefix for the commit URL.

repoProjectDirectorystringOptional

Path to a root directory for the project in the repository.

timestampstring · date-timeOptional

The timestamp of the event that triggered this import. It ensures that Git sync import and export operations are executed in the same order on GitBook and on the remote repository.

forcebooleanOptional

standalonebooleanOptional

If true, the import will generate a revision without updating the space primary content.

Responses

204

Operation to import the repository has been started.

post

/spaces/{spaceId}/git/import

HTTPcURLJavaScriptPython

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

{
  "url": "text",
  "ref": "text",
  "repoCacheID": "text",
  "repoTreeURL": "text",
  "repoCommitURL": "text",
  "repoProjectDirectory": "text",
  "timestamp": "2025-12-27T04:29:53.718Z",
  "force": true,
  "standalone": true,
  "gitInfo": {
    "provider": "github",
    "url": "text"
  }
}

204

Operation to import the repository has been started.

No content