Resolve a URL to an oEmbed object within a space

Resolves an external URL to an oEmbed representation (title, thumbnail, HTML snippet) within the context of a space. Use this to preview or embed third-party content referenced in a space's pages. Requires the URL as a query parameter.

Available in MCP

get

Authorizations

useroauth

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"
}