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
Path parameters
spaceIdstringRequired

The unique id of the space

Query parameters
urlstringRequired

URL to resolve

Responses
200

OK

application/json
Responseall of
and
one ofOptional
or
or
get
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" }

Was this helpful?