Imports

Import content into GitBook.

The Imports API provides allows you to import content into GitBook.

Import content into a space from a website

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

application/json

sourceone ofRequired

or

enhancebooleanOptional

Enhance the imported content with AI

Default: true

Responses

201

Import run created successfully.

application/json

idstringRequired

Unique ID of the import

startedAtstring · date-timeOptional

Date when the import has started

completedAtstring · date-timeOptional

Filled when the imported is in status "completed"

statusstring · enumRequired

Status of the import

Possible values:

400

Bad Request

application/json

404

Not Found

application/json

post

/org/{organizationId}/imports

HTTPcURLJavaScriptPython

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

{
  "source": {
    "type": "website",
    "url": "https://example.com"
  },
  "target": {
    "space": "text",
    "changeRequest": "text",
    "page": "text"
  },
  "enhance": true
}

{
  "id": "text",
  "startedAt": "2026-02-25T02:17:17.976Z",
  "completedAt": "2026-02-25T02:17:17.976Z",
  "status": "pending",
  "pages": [
    {
      "id": "text",
      "sourceURL": "text",
      "type": "page",
      "status": "complete"
    }
  ]
}

Cancel an import run

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

importRunIdstringRequired

The unique id of the import run

Responses

201

Import run canceled successfully.

application/json

idstringRequired

Unique ID of the import

startedAtstring · date-timeOptional

Date when the import has started

completedAtstring · date-timeOptional

Filled when the imported is in status "completed"

statusstring · enumRequired

Status of the import

Possible values:

400

Bad Request

application/json

404

Not Found

application/json

post

/org/{organizationId}/imports/{importRunId}/cancel

HTTPcURLJavaScriptPython

POST /v1/org/{organizationId}/imports/{importRunId}/cancel HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "startedAt": "2026-02-25T02:17:17.976Z",
  "completedAt": "2026-02-25T02:17:17.976Z",
  "status": "pending",
  "pages": [
    {
      "id": "text",
      "sourceURL": "text",
      "type": "page",
      "status": "complete"
    }
  ]
}