Space embeds

Render or resolve embedded content within a space.

Automatically fetch metadata or previews for embedded resources such as videos, images, or external docs, enabling richer content experiences in your space.

Resolve a URL to an embed in a given space

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

A unique entity identifier

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

Query parameters

urlstringRequired

URL to resolve

Responses

200

OK

application/json

and

anyOptional

or

or

get

/spaces/{spaceId}/embed

HTTPcURLJavaScriptPython

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

200

OK

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