> ## Documentation Index
> Fetch the complete documentation index at: https://aspect.inc/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Resolve share oEmbed

> Resolve a public share URL into oEmbed (https://oembed.com) embed metadata.



## OpenAPI

````yaml /api-reference/openapi.json get /shares/oembed
openapi: 3.1.0
info:
  title: Aspect API
  description: Manage and search media in Aspect.
  version: 1.0.0
servers:
  - url: https://api.aspect.inc
security:
  - ApiKeyAuth: []
tags:
  - name: Users
  - name: API Keys
  - name: Workspaces
  - name: Projects
  - name: Directories
  - name: Assets
  - name: Attachments
  - name: Filesystem Items
  - name: Jobs
  - name: Collections
  - name: Comments
  - name: Search
  - name: Transcription
  - name: Metadata
  - name: Shares
  - name: Share Templates
  - name: Watermarks
paths:
  /shares/oembed:
    get:
      tags:
        - Shares
      summary: Resolve share oEmbed
      description: >-
        Resolve a public share URL into oEmbed (https://oembed.com) embed
        metadata.
      operationId: get_share_oembed
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
            description: Share URL to resolve into embed markup
            title: Url
          description: Share URL to resolve into embed markup
        - name: format
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Response format; only json is supported
            title: Format
          description: Response format; only json is supported
        - name: maxwidth
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                exclusiveMinimum: 0
              - type: 'null'
            description: Maximum width of the embed in pixels
            title: Maxwidth
          description: Maximum width of the embed in pixels
        - name: maxheight
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                exclusiveMinimum: 0
              - type: 'null'
            description: Maximum height of the embed in pixels
            title: Maxheight
          description: Maximum height of the embed in pixels
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicShareOEmbedResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security: []
components:
  schemas:
    PublicShareOEmbedResponse:
      properties:
        version:
          type: string
          title: Version
          description: oEmbed protocol version
          default: '1.0'
        type:
          type: string
          title: Type
          description: oEmbed resource type (video or rich)
        title:
          type: string
          title: Title
          description: Name of the shared asset
        provider_name:
          type: string
          title: Provider Name
          description: Display name of the embed provider
        provider_url:
          type: string
          title: Provider Url
          description: Base URL of the embed provider
        width:
          type: integer
          title: Width
          description: Width in pixels of the embed html
        height:
          type: integer
          title: Height
          description: Height in pixels of the embed html
        html:
          type: string
          title: Html
          description: Iframe markup that renders the embed
      type: object
      required:
        - type
        - title
        - provider_name
        - provider_url
        - width
        - height
        - html
      title: PublicShareOEmbedResponse
      description: >-
        oEmbed (https://oembed.com) response describing how to embed a share
        URL.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.