Sketchfab oEmbed API

oEmbed-protocol endpoint at https://sketchfab.com/oembed that returns JSON containing an HTML snippet for any Sketchfab model or playlist URL. Supports maxwidth and maxheight parameters; always returns a 16:9 viewer.

OpenAPI Specification

sketchfab-oembed-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Sketchfab Download oEmbed API
  description: 'Programmatic download of downloadable Sketchfab models in glTF, GLB, and USDZ formats. The endpoint returns short-lived signed URLs for each available format. The caller must be authenticated on behalf of an end user (OAuth Authorization Code or Implicit flow); application-level downloads without user authentication require a direct contract with Sketchfab. Source formats (FBX, OBJ) are not exposed.

    '
  version: v3
  contact:
    name: Sketchfab Developer Support
    url: https://support.fab.com/s/?ProductOrigin=Sketchfab
  license:
    name: Sketchfab Developer Terms of Use
    url: https://sketchfab.com/developers/terms
servers:
- url: https://api.sketchfab.com
  description: Production API
security:
- OAuth2: []
tags:
- name: oEmbed
  description: oEmbed-protocol embed endpoint.
paths:
  /oembed:
    get:
      summary: Retrieve oEmbed Response
      description: Resolve a Sketchfab model or playlist URL into an oEmbed JSON response carrying an iframe embed snippet.
      operationId: getOEmbed
      tags:
      - oEmbed
      parameters:
      - name: url
        in: query
        required: true
        description: The full Sketchfab model or playlist URL.
        schema:
          type: string
          format: uri
      - name: maxwidth
        in: query
        description: Maximum width of the returned viewer in pixels (the aspect ratio is always 16:9).
        schema:
          type: integer
      - name: maxheight
        in: query
        description: Maximum height of the returned viewer in pixels (the aspect ratio is always 16:9).
        schema:
          type: integer
      - name: format
        in: query
        description: Response format. Only `json` is supported.
        schema:
          type: string
          default: json
          enum:
          - json
      responses:
        '200':
          description: oEmbed response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OEmbedResponse'
        '404':
          description: URL is not a recognised Sketchfab resource.
components:
  schemas:
    OEmbedResponse:
      type: object
      properties:
        type:
          type: string
          example: rich
        version:
          type: string
          example: '1.0'
        provider_name:
          type: string
          example: Sketchfab
        provider_url:
          type: string
          format: uri
          example: https://sketchfab.com
        title:
          type: string
        author_name:
          type: string
        author_url:
          type: string
          format: uri
        html:
          type: string
          description: The embeddable iframe HTML snippet.
        width:
          type: integer
        height:
          type: integer
        thumbnail_url:
          type: string
          format: uri
        thumbnail_width:
          type: integer
        thumbnail_height:
          type: integer
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://sketchfab.com/oauth2/authorize/
          tokenUrl: https://sketchfab.com/oauth2/token/
          refreshUrl: https://sketchfab.com/oauth2/token/
          scopes:
            read: Read access including model downloads.