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

Change requests

Review and manage proposed content changes.

List change requests for a space.

get
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

Query parameters
pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

statusstring · enum · default: "open"optional

If defined, only change requests matching this status will be returned.

Available options:
contributorstringoptional

If defined, only change requests with contributions from this user will be returned.

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "change-request",
      "id": "text",
      "number": 1,
      "status": "draft",
      "subject": "text",
      "createdBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "createdAt": "2025-04-03T20:28:16.020Z",
      "updatedAt": "2025-04-03T20:28:16.020Z",
      "revision": "text",
      "revisionInitial": "text",
      "revisionMergedAncestor": "text",
      "revisionMerged": "text",
      "comments": 1,
      "outdated": true,
      "urls": {
        "app": "https://example.com",
        "location": "https://example.com"
      }
    }
  ]
}

List of the space's change requests

Create a new change request for a space.

post
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

Body
subjectstringoptional

Subject of the change-request

Responses
curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": "text"
  }'
{
  "object": "change-request",
  "id": "text",
  "number": 1,
  "status": "draft",
  "subject": "text",
  "createdBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "createdAt": "2025-04-03T20:28:16.020Z",
  "updatedAt": "2025-04-03T20:28:16.020Z",
  "revision": "text",
  "revisionInitial": "text",
  "revisionMergedAncestor": "text",
  "revisionMerged": "text",
  "comments": 1,
  "outdated": true,
  "urls": {
    "app": "https://example.com",
    "location": "https://example.com"
  }
}

Change Request Created

Get the change request with the given id.

get
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

changeRequestIdstringrequired

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

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "object": "change-request",
  "id": "text",
  "number": 1,
  "status": "draft",
  "subject": "text",
  "createdBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "createdAt": "2025-04-03T20:28:16.020Z",
  "updatedAt": "2025-04-03T20:28:16.020Z",
  "revision": "text",
  "revisionInitial": "text",
  "revisionMergedAncestor": "text",
  "revisionMerged": "text",
  "comments": 1,
  "outdated": true,
  "urls": {
    "app": "https://example.com",
    "location": "https://example.com"
  }
}

The matching change request

Update the details of a change request

patch
Authorizations
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
subjectstring · max: 100optional

Subject of the change request

statusstring · enumoptional
Available options:
Responses
curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": "text",
    "status": "draft"
  }'
{
  "object": "change-request",
  "id": "text",
  "number": 1,
  "status": "draft",
  "subject": "text",
  "createdBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "createdAt": "2025-04-03T20:28:16.020Z",
  "updatedAt": "2025-04-03T20:28:16.020Z",
  "revision": "text",
  "revisionInitial": "text",
  "revisionMergedAncestor": "text",
  "revisionMerged": "text",
  "comments": 1,
  "outdated": true,
  "urls": {
    "app": "https://example.com",
    "location": "https://example.com"
  }
}

The change request has been updated

Merge a change request in the primary content of a space.

post
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

changeRequestIdstringrequired

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

Responses
curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/merge' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "revision": "text",
  "result": "merge"
}

OK

Update a change-request with changes from primary content.

post
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

changeRequestIdstringrequired

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

Responses
curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/update' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "revision": "text",
  "result": "update"
}

OK

Get all reviews for a change request.

get
Authorizations
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
formatstring · enumoptional

Output format for the content.

Available options:
pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/reviews' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "change-request-review",
      "id": "text",
      "revision": "text",
      "reviewer": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "requestedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "status": "changes-requested",
      "comment": {
        "object": "comment",
        "id": "text",
        "postedBy": {
          "object": "user",
          "id": "text",
          "displayName": "text",
          "email": "text",
          "photoURL": "text",
          "urls": {
            "location": "https://example.com"
          }
        },
        "postedAt": "2025-04-03T20:28:16.020Z",
        "editedAt": "2025-04-03T20:28:16.020Z",
        "reactions": [
          {
            "emoji": "text",
            "count": 1,
            "users": [
              {
                "user": {
                  "object": "user",
                  "id": "text",
                  "displayName": "text",
                  "email": "text",
                  "photoURL": "text",
                  "urls": {
                    "location": "https://example.com"
                  }
                },
                "reactedAt": "2025-04-03T20:28:16.020Z"
              }
            ]
          }
        ],
        "replies": 1,
        "body": "[Circular Reference]",
        "target": {
          "node": {
            "id": "text",
            "preview": "text"
          },
          "changeRequest": "text",
          "review": "text",
          "page": {
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "icon": "gear",
            "createdAt": "2025-04-03T20:28:16.020Z",
            "updatedAt": "2025-04-03T20:28:16.020Z",
            "path": "text",
            "outdated": true
          },
          "space": "text",
          "revision": "text"
        },
        "urls": {
          "location": "https://example.com"
        },
        "status": "resolved",
        "resolvedAt": "2025-04-03T20:28:16.020Z",
        "resolvedBy": {
          "object": "user",
          "id": "text",
          "displayName": "text",
          "email": "text",
          "photoURL": "text",
          "urls": {
            "location": "https://example.com"
          }
        }
      },
      "createdAt": "2025-04-03T20:28:16.020Z",
      "updatedAt": "2025-04-03T20:28:16.020Z"
    }
  ]
}

All reviews for the given change request.

Submit a review for a change request.

post
Authorizations
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
statusstring · enumrequired

The status of the submitted review.

Available options:
commentone ofoptional

Optionally, provide a comment along with the review.

Responses
curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/reviews' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "changes-requested",
    "comment": {
      "markdown": "text"
    }
  }'
{
  "object": "change-request-review",
  "id": "text",
  "revision": "text",
  "reviewer": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "requestedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "status": "changes-requested",
  "comment": {
    "object": "comment",
    "id": "text",
    "postedBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    },
    "postedAt": "2025-04-03T20:28:16.020Z",
    "editedAt": "2025-04-03T20:28:16.020Z",
    "reactions": [
      {
        "emoji": "text",
        "count": 1,
        "users": [
          {
            "user": {
              "object": "user",
              "id": "text",
              "displayName": "text",
              "email": "text",
              "photoURL": "text",
              "urls": {
                "location": "https://example.com"
              }
            },
            "reactedAt": "2025-04-03T20:28:16.020Z"
          }
        ]
      }
    ],
    "replies": 1,
    "body": {
      "markdown": "text"
    },
    "target": {
      "node": {
        "id": "text",
        "preview": "text"
      },
      "changeRequest": "text",
      "review": "text",
      "page": {
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "icon": "gear",
        "createdAt": "2025-04-03T20:28:16.020Z",
        "updatedAt": "2025-04-03T20:28:16.020Z",
        "path": "text",
        "outdated": true
      },
      "space": "text",
      "revision": "text"
    },
    "urls": {
      "location": "https://example.com"
    },
    "status": "resolved",
    "resolvedAt": "2025-04-03T20:28:16.020Z",
    "resolvedBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    }
  },
  "createdAt": "2025-04-03T20:28:16.020Z",
  "updatedAt": "2025-04-03T20:28:16.020Z"
}

A new review has been created.

Get all links in the context of a change request including their status and location where they appear.

get
Authorizations
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

statusstring · enumoptional

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

  • ok - No problems detected for this content reference.
  • broken - The target does not exist in the revision.
  • in-app - The target is a URL link pointing to an internal location in the app.
Available options:
brokenContextstring · enumoptional
Available options:
Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/links' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "stats": {
    "total": 1,
    "broken": {
      "total": 1,
      "changeRequest": 1
    }
  },
  "items": [
    {
      "status": "ok",
      "relation": "reference",
      "targetReference": {
        "kind": "file",
        "organization": {
          "object": "organization",
          "id": "text",
          "title": "text",
          "createdAt": "2025-04-03T20:28:16.020Z",
          "emailDomains": [
            "text"
          ],
          "hostname": "text",
          "type": "business",
          "useCase": "internalDocs",
          "communityType": "nonProfit",
          "defaultRole": "admin",
          "defaultContent": {
            "type": "site",
            "site": "text"
          },
          "sso": true,
          "ai": true,
          "inviteLinks": true,
          "plan": "free_2024",
          "billing": {
            "interval": "monthly",
            "endDate": "2025-04-03T20:28:16.020Z",
            "hasPaymentFailed": true,
            "isScheduledToCancel": true
          },
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trial": {
            "status": "notapplicable",
            "endDate": "2025-04-03T20:28:16.020Z",
            "decision": "downgrade"
          },
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_isOnNewTrial": true,
          "internal_billingMigration": {
            "deadline": "2025-04-03T20:28:16.020Z",
            "discountPercent": 1,
            "discountEndDate": "2025-04-03T20:28:16.020Z"
          },
          "permissions": {
            "admin": true,
            "createContent": true
          }
        },
        "space": {
          "object": "space",
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "visibility": "public",
          "createdAt": "2025-04-03T20:28:16.020Z",
          "updatedAt": "2025-04-03T20:28:16.020Z",
          "deletedAt": "2025-04-03T20:28:16.020Z",
          "editMode": "live",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "published": "https://example.com",
            "public": "https://example.com",
            "icon": "https://example.com"
          },
          "organization": "text",
          "parent": "text",
          "gitSync": {
            "repoName": "text",
            "installationProvider": "github",
            "integration": "text",
            "url": "text",
            "updatedAt": "2025-04-03T20:28:16.020Z"
          },
          "visitorAuth": {
            "backend": "custom"
          },
          "revision": "text",
          "defaultLevel": "admin",
          "comments": 1,
          "changeRequests": 1,
          "changeRequestsOpen": 1,
          "changeRequestsDraft": 1,
          "permissions": {
            "access": true,
            "admin": true,
            "edit": true,
            "comment": true,
            "merge": true,
            "review": true
          }
        },
        "versionContext": "[Circular Reference]",
        "file": {
          "id": "text",
          "name": "text",
          "contentType": "text",
          "downloadURL": "text",
          "size": 1,
          "dimensions": {
            "width": 1,
            "height": 1
          },
          "git": {
            "oid": "text",
            "path": "text"
          }
        }
      },
      "locationReferences": [
        {
          "kind": "file",
          "organization": {
            "object": "organization",
            "id": "text",
            "title": "text",
            "createdAt": "2025-04-03T20:28:16.020Z",
            "emailDomains": [
              "text"
            ],
            "hostname": "text",
            "type": "business",
            "useCase": "internalDocs",
            "communityType": "nonProfit",
            "defaultRole": "admin",
            "defaultContent": {
              "type": "site",
              "site": "text"
            },
            "sso": true,
            "ai": true,
            "inviteLinks": true,
            "plan": "free_2024",
            "billing": {
              "interval": "monthly",
              "endDate": "2025-04-03T20:28:16.020Z",
              "hasPaymentFailed": true,
              "isScheduledToCancel": true
            },
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trial": {
              "status": "notapplicable",
              "endDate": "2025-04-03T20:28:16.020Z",
              "decision": "downgrade"
            },
            "customHostname": "text",
            "blocked": {
              "reason": "security"
            },
            "internal_isOnNewTrial": true,
            "internal_billingMigration": {
              "deadline": "2025-04-03T20:28:16.020Z",
              "discountPercent": 1,
              "discountEndDate": "2025-04-03T20:28:16.020Z"
            },
            "permissions": {
              "admin": true,
              "createContent": true
            }
          },
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2025-04-03T20:28:16.020Z",
            "updatedAt": "2025-04-03T20:28:16.020Z",
            "deletedAt": "2025-04-03T20:28:16.020Z",
            "editMode": "live",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "published": "https://example.com",
              "public": "https://example.com",
              "icon": "https://example.com"
            },
            "organization": "text",
            "parent": "text",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2025-04-03T20:28:16.020Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": true
            }
          },
          "versionContext": "[Circular Reference]",
          "file": {
            "id": "text",
            "name": "text",
            "contentType": "text",
            "downloadURL": "text",
            "size": 1,
            "dimensions": {
              "width": 1,
              "height": 1
            },
            "git": {
              "oid": "text",
              "path": "text"
            }
          }
        }
      ]
    }
  ]
}

OK

Get all contributors for the change request with the given id.

get
Authorizations
Path parameters
spaceIdstringrequired

The unique id of the space

changeRequestIdstringrequired

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

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/contributors' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "updatedAt": "2025-04-03T20:28:16.020Z",
      "count": 1,
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Contributors on the change request

Get the latest content revision for a change request.

get
Authorizations
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
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}/change-requests/{changeRequestId}/content' \
  --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:28:16.020Z",
  "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

Import content in a change request.

post
Authorizations
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
urlstring · urirequired

URL of the content to import.

sourcestring · enumrequired
Available options:
Responses
curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/content/import' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "source": "website"
  }'
{
  "revision": "text",
  "importedResources": 1,
  "totalResources": 1
}

Content imported in a new revision

List all pages in the content of a change request

get
Authorizations
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
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}/change-requests/{changeRequestId}/content/pages' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-04-03T20:28:16.020Z",
      "updatedAt": "2025-04-03T20:28:16.020Z",
      "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 change request content

get
Authorizations
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

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}/change-requests/{changeRequestId}/content/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 by its ID in the content of a change request

get
Authorizations
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
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}/change-requests/{changeRequestId}/content/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 backlink locations for a file existing in a change request.

get
Authorizations
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
pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/content/files/{fileId}/backlinks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2025-04-03T20:28:16.020Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "billing": {
          "interval": "monthly",
          "endDate": "2025-04-03T20:28:16.020Z",
          "hasPaymentFailed": true,
          "isScheduledToCancel": true
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "endDate": "2025-04-03T20:28:16.020Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isOnNewTrial": true,
        "internal_billingMigration": {
          "deadline": "2025-04-03T20:28:16.020Z",
          "discountPercent": 1,
          "discountEndDate": "2025-04-03T20:28:16.020Z"
        },
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2025-04-03T20:28:16.020Z",
        "updatedAt": "2025-04-03T20:28:16.020Z",
        "deletedAt": "2025-04-03T20:28:16.020Z",
        "editMode": "live",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com",
          "public": "https://example.com",
          "icon": "https://example.com"
        },
        "organization": "text",
        "parent": "text",
        "gitSync": {
          "repoName": "text",
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2025-04-03T20:28:16.020Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "access": true,
          "admin": true,
          "edit": true,
          "comment": true,
          "merge": true,
          "review": true
        }
      },
      "versionContext": {
        "type": "revision",
        "revision": "[Circular Reference]"
      },
      "file": {
        "id": "text",
        "name": "text",
        "contentType": "text",
        "downloadURL": "text",
        "size": 1,
        "dimensions": {
          "width": 1,
          "height": 1
        },
        "git": {
          "oid": "text",
          "path": "text"
        }
      }
    }
  ]
}

OK

Get a page by its ID in a change request.

get
Authorizations
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.

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}/change-requests/{changeRequestId}/content/page/{pageId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-04-03T20:28:16.020Z",
  "updatedAt": "2025-04-03T20:28:16.020Z",
  "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 links in a page inside a change request.

get
Authorizations
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
pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/links' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "stats": {
    "total": 1,
    "broken": {
      "total": 1,
      "changeRequest": 1
    }
  },
  "items": [
    {
      "status": "ok",
      "relation": "reference",
      "targetReference": {
        "kind": "file",
        "organization": {
          "object": "organization",
          "id": "text",
          "title": "text",
          "createdAt": "2025-04-03T20:28:16.020Z",
          "emailDomains": [
            "text"
          ],
          "hostname": "text",
          "type": "business",
          "useCase": "internalDocs",
          "communityType": "nonProfit",
          "defaultRole": "admin",
          "defaultContent": {
            "type": "site",
            "site": "text"
          },
          "sso": true,
          "ai": true,
          "inviteLinks": true,
          "plan": "free_2024",
          "billing": {
            "interval": "monthly",
            "endDate": "2025-04-03T20:28:16.020Z",
            "hasPaymentFailed": true,
            "isScheduledToCancel": true
          },
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trial": {
            "status": "notapplicable",
            "endDate": "2025-04-03T20:28:16.020Z",
            "decision": "downgrade"
          },
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_isOnNewTrial": true,
          "internal_billingMigration": {
            "deadline": "2025-04-03T20:28:16.020Z",
            "discountPercent": 1,
            "discountEndDate": "2025-04-03T20:28:16.020Z"
          },
          "permissions": {
            "admin": true,
            "createContent": true
          }
        },
        "space": {
          "object": "space",
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "visibility": "public",
          "createdAt": "2025-04-03T20:28:16.020Z",
          "updatedAt": "2025-04-03T20:28:16.020Z",
          "deletedAt": "2025-04-03T20:28:16.020Z",
          "editMode": "live",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "published": "https://example.com",
            "public": "https://example.com",
            "icon": "https://example.com"
          },
          "organization": "text",
          "parent": "text",
          "gitSync": {
            "repoName": "text",
            "installationProvider": "github",
            "integration": "text",
            "url": "text",
            "updatedAt": "2025-04-03T20:28:16.020Z"
          },
          "visitorAuth": {
            "backend": "custom"
          },
          "revision": "text",
          "defaultLevel": "admin",
          "comments": 1,
          "changeRequests": 1,
          "changeRequestsOpen": 1,
          "changeRequestsDraft": 1,
          "permissions": {
            "access": true,
            "admin": true,
            "edit": true,
            "comment": true,
            "merge": true,
            "review": true
          }
        },
        "versionContext": "[Circular Reference]",
        "file": {
          "id": "text",
          "name": "text",
          "contentType": "text",
          "downloadURL": "text",
          "size": 1,
          "dimensions": {
            "width": 1,
            "height": 1
          },
          "git": {
            "oid": "text",
            "path": "text"
          }
        }
      },
      "locationReferences": [
        {
          "kind": "file",
          "organization": {
            "object": "organization",
            "id": "text",
            "title": "text",
            "createdAt": "2025-04-03T20:28:16.020Z",
            "emailDomains": [
              "text"
            ],
            "hostname": "text",
            "type": "business",
            "useCase": "internalDocs",
            "communityType": "nonProfit",
            "defaultRole": "admin",
            "defaultContent": {
              "type": "site",
              "site": "text"
            },
            "sso": true,
            "ai": true,
            "inviteLinks": true,
            "plan": "free_2024",
            "billing": {
              "interval": "monthly",
              "endDate": "2025-04-03T20:28:16.020Z",
              "hasPaymentFailed": true,
              "isScheduledToCancel": true
            },
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trial": {
              "status": "notapplicable",
              "endDate": "2025-04-03T20:28:16.020Z",
              "decision": "downgrade"
            },
            "customHostname": "text",
            "blocked": {
              "reason": "security"
            },
            "internal_isOnNewTrial": true,
            "internal_billingMigration": {
              "deadline": "2025-04-03T20:28:16.020Z",
              "discountPercent": 1,
              "discountEndDate": "2025-04-03T20:28:16.020Z"
            },
            "permissions": {
              "admin": true,
              "createContent": true
            }
          },
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2025-04-03T20:28:16.020Z",
            "updatedAt": "2025-04-03T20:28:16.020Z",
            "deletedAt": "2025-04-03T20:28:16.020Z",
            "editMode": "live",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "published": "https://example.com",
              "public": "https://example.com",
              "icon": "https://example.com"
            },
            "organization": "text",
            "parent": "text",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2025-04-03T20:28:16.020Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": true
            }
          },
          "versionContext": "[Circular Reference]",
          "file": {
            "id": "text",
            "name": "text",
            "contentType": "text",
            "downloadURL": "text",
            "size": 1,
            "dimensions": {
              "width": 1,
              "height": 1
            },
            "git": {
              "oid": "text",
              "path": "text"
            }
          }
        }
      ]
    }
  ]
}

OK

Get backlink locations for a page existing in a change request.

get
Authorizations
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
pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/backlinks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2025-04-03T20:28:16.020Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "billing": {
          "interval": "monthly",
          "endDate": "2025-04-03T20:28:16.020Z",
          "hasPaymentFailed": true,
          "isScheduledToCancel": true
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "endDate": "2025-04-03T20:28:16.020Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isOnNewTrial": true,
        "internal_billingMigration": {
          "deadline": "2025-04-03T20:28:16.020Z",
          "discountPercent": 1,
          "discountEndDate": "2025-04-03T20:28:16.020Z"
        },
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2025-04-03T20:28:16.020Z",
        "updatedAt": "2025-04-03T20:28:16.020Z",
        "deletedAt": "2025-04-03T20:28:16.020Z",
        "editMode": "live",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com",
          "public": "https://example.com",
          "icon": "https://example.com"
        },
        "organization": "text",
        "parent": "text",
        "gitSync": {
          "repoName": "text",
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2025-04-03T20:28:16.020Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "access": true,
          "admin": true,
          "edit": true,
          "comment": true,
          "merge": true,
          "review": true
        }
      },
      "versionContext": {
        "type": "revision",
        "revision": "[Circular Reference]"
      },
      "file": {
        "id": "text",
        "name": "text",
        "contentType": "text",
        "downloadURL": "text",
        "size": 1,
        "dimensions": {
          "width": 1,
          "height": 1
        },
        "git": {
          "oid": "text",
          "path": "text"
        }
      }
    }
  ]
}

OK

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

post
Authorizations
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
urlstring · urirequired

URL of the content to import.

sourcestring · enumrequired
Available options:
Responses
curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/import' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "source": "website"
  }'
{
  "revision": "text",
  "importedResources": 1,
  "totalResources": 1
}

Content imported in a new revision

Get a page by its path in a change request.

get
Authorizations
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.

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}/change-requests/{changeRequestId}/content/path/{pagePath}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2025-04-03T20:28:16.020Z",
  "updatedAt": "2025-04-03T20:28:16.020Z",
  "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 reusable content by its ID in the content of a change request

get
Authorizations
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
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}/change-requests/{changeRequestId}/content/reusable-contents/{reusableContentId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "text",
  "title": "text",
  "document": "text",
  "git": {
    "oid": "text",
    "path": "text"
  }
}

OK

Generate a URL to export the content of a change request as a PDF.

get
Authorizations
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
onlybooleanoptional

Generate a PDF only for the provided page.

pagestringoptional

ID of a specific page to generate a PDF for.

Responses
curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/pdf' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "url": "https://example.com"
}

URL of the PDF

Brainstorm with AI on a change request and stream the results as a Server-Sent Events.

post
Authorizations
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
sessionobjectrequired

Brainstorming session

Responses
curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/task/brainstorm' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "session": {
      "id": "text",
      "status": "pending",
      "messages": [
        {
          "id": "text",
          "actor": "user",
          "message": {
            "object": "document",
            "data": {
              "schemaVersion": 1,
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "nodes": [
              "[Circular Reference]"
            ]
          },
          "context": {
            "page": "text"
          },
          "logs": [
            {
              "tool": "get-page",
              "intent": "text",
              "page": {
                "id": "text",
                "type": "document",
                "title": "text",
                "path": "text"
              }
            }
          ],
          "attachment": {
            "type": "plan",
            "plan": "[Circular Reference]"
          }
        }
      ]
    }
  }'
{
  "id": "text",
  "status": "pending",
  "messages": [
    {
      "id": "text",
      "actor": "user",
      "message": {
        "object": "document",
        "data": {
          "schemaVersion": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "nodes": [
          "[Circular Reference]"
        ]
      },
      "context": {
        "page": "text"
      },
      "logs": [
        {
          "tool": "get-page",
          "intent": "text",
          "page": {
            "id": "text",
            "type": "document",
            "title": "text",
            "path": "text"
          }
        }
      ],
      "attachment": {
        "type": "plan",
        "plan": {
          "status": "pending",
          "title": "text",
          "steps": "[Circular Reference]",
          "context": {
            "page": "text"
          }
        }
      }
    }
  ]
}

Updated session.

Implement a task on a change request and stream the results as a Server-Sent Events.

post
Authorizations
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
planobjectrequired

Plan to run.

Responses
curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/change-requests/{changeRequestId}/task/implement' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "plan": {
      "status": "pending",
      "title": "text",
      "steps": [
        {
          "title": "text",
          "status": "pending",
          "instruction": {
            "object": "document",
            "data": {
              "schemaVersion": 1,
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "nodes": [
              "[Circular Reference]"
            ]
          },
          "implementation": {
            "summary": {
              "object": "document",
              "data": {
                "schemaVersion": 1,
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "nodes": [
                "[Circular Reference]"
              ]
            },
            "logs": [
              {
                "tool": "get-page",
                "intent": "text",
                "page": {
                  "id": "text",
                  "type": "document",
                  "title": "text",
                  "path": "text"
                }
              }
            ]
          }
        }
      ],
      "context": {
        "page": "text"
      }
    }
  }'
{
  "status": "pending",
  "title": "text",
  "steps": [
    {
      "title": "text",
      "status": "pending",
      "instruction": {
        "object": "document",
        "data": {
          "schemaVersion": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "nodes": [
          "[Circular Reference]"
        ]
      },
      "implementation": {
        "summary": {
          "object": "document",
          "data": {
            "schemaVersion": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "nodes": [
            "[Circular Reference]"
          ]
        },
        "logs": [
          {
            "tool": "get-page",
            "intent": "text",
            "page": {
              "id": "text",
              "type": "document",
              "title": "text",
              "path": "text"
            }
          }
        ]
      }
    }
  ],
  "context": {
    "page": "text"
  }
}

Task being implemented.

Was this helpful?