Storage

Upload and store files directly within your GitBook organization.

Whether you’re hosting images, documents, or other assets, Storage endpoints allow you to integrate those files into your documentation and spaces seamlessly.

Create a signed URL to upload a file

post

Generate a pre-signed URL that can be used to upload a file to storage

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Body

fileobjectrequired

kindstring · enumrequiredAvailable options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/storage/upload' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "file": {
      "name": "text",
      "type": "text",
      "size": 1
    },
    "kind": "customization_font"
  }'

201

400

201

{
  "object": "storage-signed-url",
  "url": "https://example.com",
  "key": "text"
}

Successfully generated signed URL for file upload