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

# Get metadata

> Full media metadata (formats, uploader, thumbnails, stats) without downloading.

The result is the source's own metadata in snake\_case, so which fields exist depends on the platform. The most useful ones are listed on [Metadata](/docs/features/metadata.md#full-metadata-fields). If you only need the title, duration, and thumbnail, [basic metadata](/docs/endpoints/basic-metadata.md) is faster.

> [!WARNING]
>
> The stream `url` inside each entry of `formats` is short-lived and often tied to the IP that fetched it. Download with [`POST /import`](/docs/endpoints/import) instead of fetching it yourself.

Poll the result with [`GET /metadata/status`](/docs/endpoints/metadata-status), or receive it by [webhook](/docs/endpoints/webhooks/metadata.md).


## OpenAPI

````yaml openapi.yaml POST /metadata
openapi: 3.1.0
info:
  title: Importly API
  version: 1.0.0
  summary: Download media, get transcripts, and read metadata from a URL.
  description: >
    Importly turns a public media URL (YouTube, TikTok, podcasts and more) into
    a downloadable file,

    a transcript, or metadata.


    Every job is asynchronous. A `POST` returns a `jobId` right away. Then
    either poll the matching

    `/status` endpoint until `status` is `completed` or `failed`, or pass a
    `webhookUrl` and Importly

    posts to you once when the job finishes: the result when it succeeds, or
    `success: false` with

    `code` and `message` when it fails.


    Every response uses one envelope: `{ "success": true, "data": … }` on
    success and

    `{ "success": false, "error": "…" }` on failure. Responses carry
    `X-RateLimit-Limit`,

    `X-RateLimit-Remaining`, `X-RateLimit-Reset` (Unix time in ms) and
    `X-RateLimit-Window` headers.


    Billing is pay-as-you-go from a credit balance. New accounts get $3.00 in
    free credits, no card required.
  contact:
    name: Importly support
    email: support@importly.io
    url: https://www.importly.io/docs
servers:
  - url: https://api.importly.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Media
    description: Download video or audio from a URL.
  - name: Transcripts
    description: Turn a media URL into text with timestamped segments.
  - name: Metadata
    description: >-
      Read a URL's title, duration, thumbnail, formats and more without
      downloading the media.
  - name: Account
    description: Your credit balance.
  - name: Account settings
    description: >-
      Stored S3 credentials and speech-to-text provider keys. These calls carry
      secrets, so the docs playground is off for them.
  - name: Webhooks
    description: Requests Importly sends to your `webhookUrl` when a job succeeds or fails.
paths:
  /metadata:
    post:
      tags:
        - Metadata
      summary: Get metadata
      description: >
        Returns everything the source knows about a URL (title, description,
        uploader, stats, thumbnails,

        and every available format) without downloading the media. If you only
        need the title, duration and

        thumbnail, use basic metadata instead; it's faster.


        Costs $0.003 per request. Metadata and basic metadata share one
        rate-limit budget.
      operationId: getMetadata
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetadataRequest'
            example:
              url: https://www.youtube.com/watch?v=jNQXAC9IVRw
              webhookUrl: https://example.com/webhooks/importly
      responses:
        '200':
          description: The metadata job was queued.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueuedJobResponse'
              example:
                success: true
                data:
                  jobId: e0b5df98-0867-490a-b321-cd10fdd80130
                  status: queued
                  message: >-
                    Metadata request queued. You will receive a webhook when
                    it's complete.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    MetadataRequest:
      type: object
      required:
        - url
      properties:
        url:
          type: string
          format: uri
          description: >-
            Public media page URL, e.g. a YouTube, TikTok or podcast episode
            link.
          example: https://www.youtube.com/watch?v=jNQXAC9IVRw
        webhookUrl:
          $ref: '#/components/schemas/WebhookUrl'
    QueuedJobResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
            - jobId
            - status
            - message
          properties:
            jobId:
              type: string
              format: uuid
              description: Pass this as `id` to the matching status endpoint.
            status:
              type: string
              const: queued
            message:
              type: string
    WebhookUrl:
      type: string
      format: uri
      description: >
        HTTPS URL that receives the result when the job finishes. It must not
        point to a private or

        internal address. A job that fails for good sends one webhook with
        `success: false`, `code`

        and `message`.
      example: https://example.com/webhooks/importly
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: What went wrong, in plain English.
        code:
          type: string
          description: >
            A stable, machine-readable error code: `UNAUTHORIZED`,
            `INSUFFICIENT_BALANCE`, `RATE_LIMITED`,

            `INVALID_URL`, `INVALID_REQUEST`, `NOT_FOUND` or `INTERNAL_ERROR`.
          examples:
            - INVALID_URL
        documentationUrl:
          type: string
          format: uri
          description: A page explaining this error and how to fix it.
          examples:
            - https://www.importly.io/docs/errors/invalid-url
    InsufficientBalanceError:
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          required:
            - code
          properties:
            code:
              type: string
              const: INSUFFICIENT_BALANCE
            endpoint:
              type: string
              description: The rate-limit bucket the request counted against.
            balanceRequired:
              type: number
              description: Minimum balance in US dollars needed to start the job.
    RateLimitError:
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            limit:
              type: integer
              description: Requests allowed per window.
            remaining:
              type: integer
              description: Requests left in the window.
            reset:
              type: integer
              description: When the window resets, as Unix time in milliseconds.
            retryAfter:
              type: integer
              description: Seconds to wait before retrying.
            endpoint:
              type: string
              description: The rate-limit bucket the request counted against.
            outstandingLimit:
              type: integer
              description: >-
                Present instead of `limit` when too many of your jobs of this
                kind are queued or running; the most allowed at once.
            outstanding:
              type: integer
              description: >-
                Present with `outstandingLimit`. How many of your jobs of this
                kind are queued or running.
  responses:
    BadRequest:
      description: A parameter is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missingUrl:
              summary: Missing url
              value:
                success: false
                error: 'Missing required parameter: url'
                code: INVALID_URL
                documentationUrl: https://www.importly.io/docs/errors/invalid-url
            invalidUrl:
              summary: Invalid url
              value:
                success: false
                error: Invalid URL format - must be a valid HTTP or HTTPS URL
                code: INVALID_URL
                documentationUrl: https://www.importly.io/docs/errors/invalid-url
            webhookNotHttps:
              summary: Webhook URL isn't HTTPS
              value:
                success: false
                error: Webhook URL must use HTTPS
                code: INVALID_REQUEST
                documentationUrl: https://www.importly.io/docs/errors/invalid-request
    Unauthorized:
      description: The API key is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missingHeader:
              summary: No Authorization header
              value:
                success: false
                error: >-
                  Missing or invalid Authorization header. Must be in format:
                  Bearer YOUR_API_KEY
                code: UNAUTHORIZED
                documentationUrl: https://www.importly.io/docs/errors/unauthorized
            invalidKey:
              summary: Unknown key
              value:
                success: false
                error: Invalid API key
                code: UNAUTHORIZED
                documentationUrl: https://www.importly.io/docs/errors/unauthorized
    PaymentRequired:
      description: >-
        Your balance is below what the job needs to start ($0.01 for an import
        or transcription, $0.003 for metadata). Add credits on the Billing page.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InsufficientBalanceError'
          example:
            success: false
            error: Insufficient balance. Please add credits to your account.
            code: INSUFFICIENT_BALANCE
            endpoint: /import
            balanceRequired: 0.01
            documentationUrl: https://www.importly.io/docs/errors/insufficient-credits
    TooManyRequests:
      description: >-
        You hit the hourly rate limit for this endpoint, or have too many jobs
        queued or running (`outstanding` and `outstandingLimit` are set). Wait
        `retryAfter` seconds and retry.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-RateLimit-Window:
          $ref: '#/components/headers/X-RateLimit-Window'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitError'
          example:
            success: false
            error: 'Rate limit exceeded. Limit: 240 requests per 1 h'
            code: RATE_LIMITED
            limit: 240
            remaining: 0
            reset: 1763200000000
            retryAfter: 1800
            endpoint: /import
            documentationUrl: https://www.importly.io/docs/errors/rate-limited
    InternalError:
      description: Unexpected server error. Retry with exponential backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Internal server error
            code: INTERNAL_ERROR
            documentationUrl: https://www.importly.io/docs/errors/server-error
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When the window resets, as Unix time in milliseconds.
      schema:
        type: integer
    X-RateLimit-Window:
      description: Window length, e.g. `1 h`.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your API key from the dashboard, sent as `Authorization: Bearer <api
        key>`.

````

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