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

# Recognize what a social URL points to

> Free and local: no platform is contacted and nothing is stored. A Meta Ad Library link returns id null, because the id it carries is a deeplink id rather than the archive id an item is known by.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/resolve
openapi: 3.1.0
info:
  title: Refmatter API
  version: 0.1.0
  description: >-
    Public social data API: one request turns a TikTok, Instagram, YouTube or
    Meta Ad Library link into structured data; import it to keep verified media,
    a transcript and provenance.
servers:
  - url: https://api.refmatter.com
security:
  - bearerApiKey: []
tags:
  - name: workspaces
    x-group: Workspaces
    description: Manage workspaces and review their usage.
  - name: imports
    x-group: Imports
    description: Start imports from source URLs and check their progress.
  - name: urls
    x-group: URLs
    description: Identify the platform and object represented by a social URL.
  - name: items
    x-group: Items
    description: List and look up items from supported platforms.
  - name: accounts
    x-group: Accounts
    description: Look up accounts and retrieve their current data.
  - name: comments
    x-group: Comments
    description: List comments for supported items.
  - name: search
    x-group: Search
    description: Search supported platforms for items or accounts.
  - name: references
    x-group: References
    description: Manage saved references and their transcripts and media.
  - name: media
    x-group: Media
    description: Create short-lived access to stored media.
  - name: sourceRoutes
    x-group: Sources
    description: List the supported platforms and objects with their limits.
paths:
  /v1/resolve:
    get:
      tags:
        - urls
      summary: Recognize what a social URL points to
      description: >-
        Free and local: no platform is contacted and nothing is stored. A Meta
        Ad Library link returns id null, because the id it carries is a deeplink
        id rather than the archive id an item is known by.
      operationId: urlsResolve
      parameters:
        - name: url
          in: query
          required: true
          description: Absolute http or https URL of a post, video or account
          schema:
            type: string
            minLength: 1
            maxLength: 2048
      responses:
        '200':
          description: What the URL points to
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resolution'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Service or dependency unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - bearerApiKey: []
components:
  schemas:
    Resolution:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        object:
          type: string
          const: resolution
        url:
          type: string
          minLength: 1
          maxLength: 2048
        canonicalUrl:
          anyOf:
            - type: string
              minLength: 1
              maxLength: 2048
            - type: 'null'
        platform:
          anyOf:
            - type: string
              enum:
                - youtube
                - tiktok
                - instagram
                - meta_ad_library
            - type: 'null'
        target:
          anyOf:
            - type: string
              enum:
                - item
                - account
            - type: 'null'
        id:
          anyOf:
            - type: string
              pattern: >-
                ^(youtube|tiktok|instagram|meta_ad_library):[A-Za-z0-9._-]{1,128}$
            - type: 'null'
        supported:
          type: boolean
        reason:
          anyOf:
            - type: string
              enum:
                - unsupported_host
                - short_link
                - account_not_supported
                - object_not_supported
                - unrecognized_url
            - type: 'null'
      required:
        - object
        - url
        - canonicalUrl
        - platform
        - target
        - id
        - supported
        - reason
      additionalProperties: false
    ErrorEnvelope:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_input
                - unauthenticated
                - invalid_credential
                - credential_conflict
                - forbidden
                - policy_blocked
                - route_disabled
                - route_degraded
                - not_found
                - bootstrap_conflict
                - last_owner_conflict
                - revision_conflict
                - idempotency_conflict
                - unavailable_private
                - unavailable_restricted
                - unavailable_removed
                - unsupported_object
                - unsupported_media
                - insufficient_credits
                - limit_exceeded
                - rate_limited
                - source_changed
                - network_timeout
                - network_transport
                - media_invalid
                - storage_unavailable
                - retry_exhausted
                - internal_error
            message:
              type: string
              minLength: 1
              maxLength: 240
            retryable:
              type: boolean
            requestId:
              type: string
              minLength: 8
              maxLength: 128
              pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$
            details:
              type: object
              propertyNames:
                type: string
              additionalProperties:
                type:
                  - string
                  - number
                  - boolean
          required:
            - code
            - message
            - retryable
            - requestId
            - details
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer

````