URLs

Manage URLs for your content and resources.

Was this helpful?

Resolve a URL to an embed

get

/urls/embed

Authorizations

Query parameters

urlstringrequired

URL to resolve

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/urls/embed?url=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "title": "text",
  "site": "text",
  "icon": "text",
  "type": "link"
}

Resolve a URL of a published content.

get

/urls/published

Authorizations

Query parameters

urlstring · uri · max: 2048required

URL to resolve

visitorAuthTokenstring

JWT token generated for a visitor auth session

redirectOnErrorboolean · default: false

When true redirects the user to the authentication/fallback URL if the visitor auth token is invalid

cacheboolean · default: false

When true the HTTP response can be cached by the CDN

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/urls/published?url=https%3A%2F%2Fexample.com' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

{
  "redirect": "https://example.com",
  "target": "application"
}

Resolve a URL to a content (space, collection, page)

get

/urls/content

Authorizations

Query parameters

urlstringrequired

URL to resolve

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/urls/content?url=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "collection": {
    "id": "text",
    "title": "text",
    "description": "text",
    "organization": "text",
    "parent": "text",
    "defaultLevel": "admin",
    "object": "collection",
    "urls": {
      "location": "https://example.com",
      "app": "https://example.com"
    },
    "permissions": {
      "admin": true,
      "create": true
    }
  }
}