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

# Get metadata status

> Poll a metadata job until it's completed or failed. Completed jobs carry the source's full metadata.



## OpenAPI

````yaml openapi.yaml GET /metadata/status
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 the result to you when the job succeeds.


    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 completes.
paths:
  /metadata/status:
    get:
      tags:
        - Metadata
      summary: Get metadata status
      description: >
        Returns the state of a metadata job. Poll it until `status` is
        `completed` or `failed`. The `result` is the

        source's raw metadata in snake_case; which fields exist varies by
        platform. Free.
      operationId: getMetadataStatus
      parameters:
        - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          description: >-
            The job's current state. A failed job still returns 200, with
            `status` set to `failed`.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/MetadataStatus'
              examples:
                completed:
                  summary: Completed (abridged; a real result has about 80 fields)
                  value:
                    success: true
                    data:
                      jobId: e0b5df98-0867-490a-b321-cd10fdd80130
                      status: completed
                      result:
                        id: jNQXAC9IVRw
                        title: Me at the zoo
                        description: |-
                          …
                          00:00 Intro
                          00:05 The cool thing
                          00:17 End
                        uploader: jawed
                        uploader_id: '@jawed'
                        upload_date: '20050424'
                        duration: 19
                        view_count: 448211510
                        like_count: 20134056
                        thumbnail: https://i.ytimg.com/vi/jNQXAC9IVRw/hqdefault.jpg
                        thumbnails:
                          - id: '44'
                            url: >-
                              https://i.ytimg.com/vi_webp/jNQXAC9IVRw/maxresdefault.webp
                            preference: 0
                        formats:
                          - format_id: '140'
                            url: >-
                              https://rr5---sn-bvvbaxivnuxq5uu-p5is.googlevideo.com/videoplayback?…
                            ext: m4a
                            vcodec: none
                            acodec: mp4a.40.2
                            abr: 129.796
                            tbr: 129.796
                            filesize: 309288
                            protocol: https
                          - format_id: '134'
                            url: >-
                              https://rr5---sn-bvvbaxivnuxq5uu-p5is.googlevideo.com/videoplayback?…
                            ext: mp4
                            height: 240
                            width: 320
                            fps: 15
                            vcodec: avc1.4D400C
                            acodec: none
                            vbr: 136.218
                            tbr: 136.218
                            filesize: 322379
                            protocol: https
                        tags:
                          - me at the zoo
                          - jawed karim
                          - first youtube video
                        categories:
                          - Film & Animation
                        webpage_url: https://www.youtube.com/watch?v=jNQXAC9IVRw
                        original_url: https://www.youtube.com/watch?v=jNQXAC9IVRw
                failed:
                  summary: Failed
                  value:
                    success: true
                    data:
                      jobId: e0b5df98-0867-490a-b321-cd10fdd80130
                      status: failed
                      message: Source video is unavailable.
                      code: VIDEO_UNAVAILABLE
                      documentationUrl: https://www.importly.io/docs/errors/media-unavailable
        '400':
          $ref: '#/components/responses/MissingJobId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/JobNotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    JobId:
      name: id
      in: query
      required: true
      description: The `jobId` returned when you started the job.
      schema:
        type: string
        format: uuid
      example: a824760e-ece1-4415-8838-ce2a7785ea6b
  schemas:
    MetadataStatus:
      type: object
      required:
        - jobId
        - status
      properties:
        jobId:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/JobStatusValue'
        result:
          $ref: '#/components/schemas/MetadataResult'
        message:
          type: string
          description: Only when `failed`. Why the job failed.
        code:
          type: string
          description: >-
            Only when `failed`, usually. A stable error code, e.g.
            `VIDEO_UNAVAILABLE` or `VIDEO_PRIVATE`.
        documentationUrl:
          type: string
          format: uri
          description: >-
            Only when `failed` with a known `code`. A page explaining the error
            and how to fix it, e.g.
            `https://www.importly.io/docs/errors/media-unavailable`.
    JobStatusValue:
      type: string
      enum:
        - queued
        - running
        - completed
        - failed
      description: >-
        `queued` and `running` mean keep polling; `completed` and `failed` are
        final.
    MetadataResult:
      type: object
      additionalProperties: true
      description: >-
        The source's raw metadata in snake_case. Which fields exist varies by
        platform.
      properties:
        id:
          type: string
        title:
          type: string
        description:
          type: string
        duration:
          type: number
          description: Length in seconds.
        uploader:
          type: string
        uploader_id:
          type: string
        upload_date:
          type: string
          description: '`YYYYMMDD`'
        view_count:
          type: integer
        like_count:
          type: integer
        thumbnail:
          type: string
        thumbnails:
          type: array
          items:
            type: object
            additionalProperties: true
        formats:
          type: array
          description: >
            Every available stream (`format_id`, `ext`, `height`, `width`,
            `vcodec`, `acodec`, `tbr`, `filesize`, `url`, …).

            Stream URLs are short-lived and often tied to the fetching IP;
            download with `POST /import` instead.
          items:
            type: object
            additionalProperties: true
        tags:
          type: array
          items:
            type: string
        categories:
          type: array
          items:
            type: string
        webpage_url:
          type: string
    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
    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.
            concurrentLimit:
              type: integer
              description: >-
                Present instead of `limit` when too many of your jobs are
                already running.
            currentConcurrent:
              type: integer
              description: Present with `concurrentLimit`.
  responses:
    MissingJobId:
      description: The `id` query parameter is missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Missing id
            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
    JobNotFound:
      description: No job with that `id` belongs to your account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Import job not found
            code: NOT_FOUND
            documentationUrl: https://www.importly.io/docs/errors/not-found
    TooManyRequests:
      description: >-
        You hit the hourly rate limit for this endpoint. 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.