Default

Deprecated

Ask a question to an AI across spaces that is accessible by the currently authenticated target.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

querystringRequired

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Return query details in the result

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/search/ask

HTTPcURLJavaScriptPython

GET /v1/search/ask?query=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Ask a question to an AI across spaces that is accessible by the currently authenticated target.

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Return query details in the result

Body

application/json

querystringRequired

previousQueriesstring[] · max: 10OptionalDeprecated

Responses

200

OK

application/json

default

Unexpected Error

application/json

post

/search/ask

HTTPcURLJavaScriptPython

POST /v1/search/ask HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "query": "text"
}

{
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Deprecated

Get a list of questions recommended by AI for a list of content. Deprecated, use getRecommendedQuestionsInOrganization instead.

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

documentsstring[] · min: 1 · max: 50Required

Responses

200

OK

application/json

default

Unexpected Error

application/json

post

/search/questions

HTTPcURLJavaScriptPython

POST /v1/search/questions HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "documents": [
    "text"
  ]
}

{
  "questions": [
    "text"
  ]
}

Search content in a space

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/search

HTTPcURLJavaScriptPython

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

{
  "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"
          }
        }
      ],
      "urls": {
        "app": "https://example.com"
      }
    }
  ]
}

Deprecated

Ask a question to an AI within the context of the space.

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

querystringRequired

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Return query details in the result

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/search/ask

HTTPcURLJavaScriptPython

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

{
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Ask a question to an AI within the context of the space.

post

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Return query details in the result

Body

application/json

querystringRequired

previousQueriesstring[] · max: 10OptionalDeprecated

Responses

200

OK

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/search/ask

HTTPcURLJavaScriptPython

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

{
  "query": "text"
}

{
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Ask a question to an AI within the context of the space and stream the answer as a Server-Sent Events URL.

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

querystringRequired

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Ensure that the response is never null

Responses

200

OK

text/event-stream

default

Unexpected Error

application/json

get

/spaces/{spaceId}/search/ask/stream

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/search/ask/stream?query=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "answer",
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Get a list of questions that can be asked in a space.

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/search/questions

HTTPcURLJavaScriptPython

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

{
  "questions": [
    "text"
  ]
}

Stream a list of questions that can be asked in a space.

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

200

OK

text/event-stream

default

Unexpected Error

application/json

get

/spaces/{spaceId}/search/questions/stream

HTTPcURLJavaScriptPython

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

{
  "question": "text"
}

Get the current primary content revision for a space

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content

HTTPcURLJavaScriptPython

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

{
  "object": "revision",
  "id": "text",
  "parents": [
    "text"
  ],
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": "2026-01-25T23:51:27.848Z",
  "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"
}

Import content in a space.

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

application/json

urlstring · uriRequired

URL of the content to import.

sourcestring · enumRequiredPossible values:

Responses

201

Content imported in a new revision

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/content/import

HTTPcURLJavaScriptPython

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

{
  "url": "https://example.com",
  "source": "website"
}

{
  "revision": "text",
  "importedResources": 1,
  "totalResources": 1
}

List all pages for the main revision content of a space

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content/pages

HTTPcURLJavaScriptPython

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

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": {
        "integration": "text",
        "source": "text",
        "props": {
          "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
        },
        "dependsOn": [
          {
            "kind": "space",
            "space": "text"
          }
        ]
      }
    }
  ]
}

List all files for the main revision content of a space

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

default

Unexpected Error

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: */*

{
  "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 file by its ID in the main revision of a space

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content/files/{fileId}

HTTPcURLJavaScriptPython

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

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

Get a page by its ID in the primary content.

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:

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

default

Unexpected Error

application/json

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: */*

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-01-25T23:51:27.848Z",
  "updatedAt": "2026-01-25T23:51:27.848Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "documentId": "text",
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "computed": {
    "integration": "text",
    "source": "text",
    "props": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    },
    "dependsOn": [
      {
        "kind": "space",
        "space": "text"
      }
    ]
  }
}

Import external content into a page by its ID.

post

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

Body

application/json

urlstring · uriRequired

URL of the content to import.

sourcestring · enumRequiredPossible values:

Responses

201

Content imported in a new revision

application/json

default

Unexpected Error

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "url": "https://example.com",
  "source": "website"
}

{
  "revision": "text",
  "importedResources": 1,
  "totalResources": 1
}

Get a page by its path in the primary content.

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:

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

default

Unexpected Error

application/json

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: */*

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-01-25T23:51:27.848Z",
  "updatedAt": "2026-01-25T23:51:27.848Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "documentId": "text",
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "computed": {
    "integration": "text",
    "source": "text",
    "props": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    },
    "dependsOn": [
      {
        "kind": "space",
        "space": "text"
      }
    ]
  }
}

Get a reusable content by its ID in the main revision of a space

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content/reusable-contents/{reusableContentId}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "title": "text",
  "document": "text",
  "git": {
    "oid": "text",
    "path": "text"
  }
}

Get the document for a page in a computed content.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

requeststringRequired

LZ-string compressed JSON request

Responses

200

Document computed

application/json

Responseone of

or

or

object · EmptyOptional

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content/computed/document

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/computed/document?request=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "markdown": "text"
}

Get the computed pages for a page in a computed content.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

requeststringRequired

LZ-string compressed JSON request

Responses

200

Computed pages and their associated files

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content/computed/page

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/content/computed/page?request=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": {
        "integration": "text",
        "source": "text",
        "props": {
          "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
        },
        "dependsOn": [
          {
            "kind": "space",
            "space": "text"
          }
        ]
      }
    }
  ],
  "files": [
    {
      "id": "text",
      "name": "text",
      "contentType": "text",
      "downloadURL": "text",
      "size": 1,
      "dimensions": {
        "width": 1,
        "height": 1
      },
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ]
}

Get a document by its ID in a space.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/documents/{documentId}

HTTPcURLJavaScriptPython

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

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

Get the latest content revision for a change request.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content

HTTPcURLJavaScriptPython

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

{
  "object": "revision",
  "id": "text",
  "parents": [
    "text"
  ],
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": "2026-01-25T23:51:27.848Z",
  "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"
}

Import content in a change request.

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Body

application/json

urlstring · uriRequired

URL of the content to import.

sourcestring · enumRequiredPossible values:

Responses

201

Content imported in a new revision

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/change-requests/{changeRequestId}/content/import

HTTPcURLJavaScriptPython

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/content/import HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "url": "https://example.com",
  "source": "website"
}

{
  "revision": "text",
  "importedResources": 1,
  "totalResources": 1
}

List all pages in the content of a change request

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/pages

HTTPcURLJavaScriptPython

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

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": {
        "integration": "text",
        "source": "text",
        "props": {
          "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
        },
        "dependsOn": [
          {
            "kind": "space",
            "space": "text"
          }
        ]
      }
    }
  ]
}

List all files in a change request content

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/files

HTTPcURLJavaScriptPython

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

{
  "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 file by its ID in the content of a change request

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/files/{fileId}

HTTPcURLJavaScriptPython

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

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

Get a page by its ID in a change request.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

pageIdstringRequired

The unique id of the page

Query parameters

formatstring · enumOptional

Output format for the content.

Possible 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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-01-25T23:51:27.848Z",
  "updatedAt": "2026-01-25T23:51:27.848Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "documentId": "text",
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "computed": {
    "integration": "text",
    "source": "text",
    "props": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    },
    "dependsOn": [
      {
        "kind": "space",
        "space": "text"
      }
    ]
  }
}

Import external content into a page of a change-request by its ID.

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

pageIdstringRequired

The unique id of the page

Body

application/json

urlstring · uriRequired

URL of the content to import.

sourcestring · enumRequiredPossible values:

Responses

201

Content imported in a new revision

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/import

HTTPcURLJavaScriptPython

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/import HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "url": "https://example.com",
  "source": "website"
}

{
  "revision": "text",
  "importedResources": 1,
  "totalResources": 1
}

Get a page by its path in a change request.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

pagePathstringRequired

The path of the page in the revision.

Query parameters

formatstring · enumOptional

Output format for the content.

Possible 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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/path/{pagePath}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-01-25T23:51:27.848Z",
  "updatedAt": "2026-01-25T23:51:27.848Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "documentId": "text",
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "computed": {
    "integration": "text",
    "source": "text",
    "props": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    },
    "dependsOn": [
      {
        "kind": "space",
        "space": "text"
      }
    ]
  }
}

Get a reusable content by its ID in the content of a change request

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/reusable-contents/{reusableContentId}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "title": "text",
  "document": "text",
  "git": {
    "oid": "text",
    "path": "text"
  }
}

Get a specific revision in a space

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

or

or

or

or

default

Unexpected Error

application/json

get

/spaces/{spaceId}/revisions/{revisionId}

HTTPcURLJavaScriptPython

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

{
  "object": "revision",
  "id": "text",
  "parents": [
    "text"
  ],
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": "2026-01-25T23:51:27.848Z",
  "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"
}

Return the semantic changes between a revision and its parent.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/revisions/{revisionId}/changes

HTTPcURLJavaScriptPython

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

{
  "changes": [
    {
      "type": "page_created",
      "page": {
        "id": "text",
        "type": "document",
        "title": "text",
        "path": "text"
      }
    }
  ],
  "more": 1
}

List all pages in a revision

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/revisions/{revisionId}/pages

HTTPcURLJavaScriptPython

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

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": {
        "integration": "text",
        "source": "text",
        "props": {
          "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
        },
        "dependsOn": [
          {
            "kind": "space",
            "space": "text"
          }
        ]
      }
    }
  ]
}

List all files in a revision

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/revisions/{revisionId}/files

HTTPcURLJavaScriptPython

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

{
  "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 file in a revision by its ID

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/revisions/{revisionId}/files/{fileId}

HTTPcURLJavaScriptPython

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

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

Get a page by its ID in a revision.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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:

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/revisions/{revisionId}/page/{pageId}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-01-25T23:51:27.848Z",
  "updatedAt": "2026-01-25T23:51:27.848Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "documentId": "text",
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "computed": {
    "integration": "text",
    "source": "text",
    "props": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    },
    "dependsOn": [
      {
        "kind": "space",
        "space": "text"
      }
    ]
  }
}

Get a page by its path in a revision.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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:

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/revisions/{revisionId}/path/{pagePath}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-01-25T23:51:27.848Z",
  "updatedAt": "2026-01-25T23:51:27.848Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "documentId": "text",
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:27.848Z",
      "updatedAt": "2026-01-25T23:51:27.848Z",
      "markdown": "text",
      "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": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "computed": "[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": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "computed": {
    "integration": "text",
    "source": "text",
    "props": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    },
    "dependsOn": [
      {
        "kind": "space",
        "space": "text"
      }
    ]
  }
}

Get reusbale content in a revision by its ID

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

default

Unexpected Error

application/json

get

/spaces/{spaceId}/revisions/{revisionId}/reusable-contents/{reusableContentId}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "title": "text",
  "document": "text",
  "git": {
    "oid": "text",
    "path": "text"
  }
}

Render an integration UI in the context of an installation.

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

Query parameters

requeststringRequired

LZ-string compressed JSON request

Responses

200

ContentKit element to render

application/json

Responseone of

Output of the integration when rendering a UI.

or

default

Unexpected Error

application/json

get

/integrations/{integrationName}/render

HTTPcURLJavaScriptPython

GET /v1/integrations/{integrationName}/render?request=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "element",
  "element": {
    "type": "block",
    "children": [
      {
        "type": "button",
        "style": "primary",
        "onPress": "[Circular Reference]",
        "icon": "close",
        "trailingIcon": "close",
        "label": "text",
        "tooltip": "text",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        },
        "disabled": true
      }
    ],
    "controls": [
      {
        "icon": "close",
        "label": "text",
        "onPress": "[Circular Reference]",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        }
      }
    ]
  },
  "state": {},
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    }
  }
}

Render an integration UI in the context of an installation.

post

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

Body

application/json

componentIdstringRequired

ID of the component to render in the integration.

stateobjectOptional

Current local state of the UI.

contextone ofRequired

Object representing the context in which a ContentKit component is rendered.

or

or

or

or

actionany ofOptional

or

anyOptional

or

or

or

or

or

Responses

200

ContentKit element to render

application/json

Responseone of

Output of the integration when rendering a UI.

or

default

Unexpected Error

application/json

post

/integrations/{integrationName}/render

HTTPcURLJavaScriptPython

POST /v1/integrations/{integrationName}/render HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "componentId": "text",
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
      }
    }
  },
  "state": {},
  "context": {
    "theme": "dark",
    "type": "configuration_account",
    "organizationId": "text"
  },
  "action": {
    "action": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "type": "element",
  "element": {
    "type": "block",
    "children": [
      {
        "type": "button",
        "style": "primary",
        "onPress": "[Circular Reference]",
        "icon": "close",
        "trailingIcon": "close",
        "label": "text",
        "tooltip": "text",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        },
        "disabled": true
      }
    ],
    "controls": [
      {
        "icon": "close",
        "label": "text",
        "onPress": "[Circular Reference]",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        }
      }
    ]
  },
  "state": {},
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    }
  }
}

Install integration on a space using an existing installation

post

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

installationIdstringRequired

Identifier of the installation

Query parameters

extendedbooleanOptional

If true, returns the space object in each items. If false, returns the space ID in each items.

Default: false

Body

application/json

spacestringRequired

ID of the space to install the integration on

Responses

201

Integration installed successfully on space

application/json

404

Not Found

application/json

default

Unexpected Error

application/json

post

/integrations/{integrationName}/installations/{installationId}/spaces

HTTPcURLJavaScriptPython

POST /v1/integrations/{integrationName}/installations/{installationId}/spaces HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "space": "text"
}

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "space": "text"
}

Uninstall the integration from a space

delete

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

installationIdstringRequired

Identifier of the installation

spaceIdstringRequired

The unique id of the space

Responses

204

The space installation has been deleted.

default

Unexpected Error

application/json

delete

/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId}

HTTPcURLJavaScriptPython

DELETE /v1/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update external IDs and configurations of an integration's installation for a space

patch

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

installationIdstringRequired

Identifier of the installation

spaceIdstringRequired

The unique id of the space

Query parameters

extendedbooleanOptional

If true, returns the space object in each items. If false, returns the space ID in each items.

Default: false

Body

application/json

externalIdsstring[] · max: 5Optional

External IDs assigned by the integration.

Responses

200

The space installation has been updated.

application/json

default

Unexpected Error

application/json

patch

/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId}

HTTPcURLJavaScriptPython

PATCH /v1/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "externalIds": [
    "text"
  ],
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "space": "text"
}

Uninstall the integration from a site

delete

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

installationIdstringRequired

Identifier of the installation

siteIdstringRequired

The unique id of the site

Responses

204

The site installation has been deleted.

default

Unexpected Error

application/json

delete

/integrations/{integrationName}/installations/{installationId}/sites/{siteId}

HTTPcURLJavaScriptPython

DELETE /v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update external IDs and configurations of an integration's installation for a site

patch

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

installationIdstringRequired

Identifier of the installation

siteIdstringRequired

The unique id of the site

Query parameters

extendedbooleanOptional

If true, returns the site object in each items. If false, returns the site ID in each items.

Default: false

Body

application/json

externalIdsstring[] · max: 5Optional

External IDs assigned by the integration.

Responses

200

The site installation has been updated.

application/json

default

Unexpected Error

application/json

patch

/integrations/{integrationName}/installations/{installationId}/sites/{siteId}

HTTPcURLJavaScriptPython

PATCH /v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "externalIds": [
    "text"
  ],
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "site": "text"
}

Ask a question.

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Return query details in the result

Body

application/json

querystringRequired

previousQueriesstring[] · max: 10OptionalDeprecated

Responses

200

OK

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/ask

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/ask HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "query": "text"
}

{
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Get a list of questions recommended to be asked in an organization.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/ask/questions

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/ask/questions HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "questions": [
    "text"
  ]
}

Stream a list of questions recommended to be asked in an organization.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

OK

text/event-stream

default

Unexpected Error

application/json

get

/orgs/{organizationId}/ask/questions/stream

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/ask/questions/stream HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "question": "text"
}

Ask a question to an AI across spaces that is accessible by the currently authenticated target and stream the answer as a Server-Sent Events URL.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

querystringRequired

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Return query details in the result

Responses

200

OK

text/event-stream

default

Unexpected Error

application/json

get

/orgs/{organizationId}/ask/stream

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/ask/stream?query=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "answer",
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Search content in a site

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Body

application/json

and

anyOptional

or

or

or

Responses

200

OK

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/sites/{siteId}/search

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/sites/{siteId}/search HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "query": "text",
  "scope": {
    "mode": "default",
    "includedSiteSpaces": [
      "text"
    ]
  }
}

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

Ask a question in a site. The response is streamed.

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Body

application/json

questionstring · max: 512Required

scopeone ofRequired

or

or

Responses

200

OK

text/event-stream

default

Unexpected Error

application/json

post

/orgs/{organizationId}/sites/{siteId}/ask

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/sites/{siteId}/ask HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "question": "text",
  "context": {
    "siteSpaceId": "text"
  },
  "scope": {
    "mode": "default",
    "includedSiteSpaces": [
      "text"
    ]
  }
}

{
  "type": "answer",
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}