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

# Save a transcription provider key

> Store your AssemblyAI, Deepgram, or OpenAI key so transcriptions with that provider don't need apiKey.

> [!NOTE]
>
> There's no "Try it" on this page, so your storage secrets and provider keys never pass through the docs site. Run the request from your own terminal or server.


## OpenAPI

````yaml openapi.yaml POST /transcription-provider
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:
  /transcription-provider:
    post:
      tags:
        - Account settings
      summary: Save a transcription provider key
      description: >
        Stores your API key for a speech-to-text provider, so `POST /transcribe`
        (and imports with

        `includeTranscript`) can use that provider without sending `apiKey` each
        time. Saving again replaces the key.
      operationId: saveTranscriptionProvider
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TranscriptionProviderInput'
            example:
              provider: deepgram
              apiKey: YOUR_DEEPGRAM_KEY
      responses:
        '200':
          description: The key was saved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
              example:
                success: true
                message: Transcription provider saved successfully
        '400':
          description: A field is missing or the provider isn't supported.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                missingFields:
                  summary: Missing fields
                  value:
                    success: false
                    error: 'Missing required fields: provider, apiKey'
                    code: INVALID_REQUEST
                    documentationUrl: https://www.importly.io/docs/errors/invalid-request
                invalidProvider:
                  summary: Unsupported provider
                  value:
                    success: false
                    error: >-
                      Invalid provider: 'importly'. Supported: assemblyai,
                      deepgram, openai
                    code: INVALID_REQUEST
                    documentationUrl: https://www.importly.io/docs/errors/invalid-request
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    TranscriptionProviderInput:
      type: object
      required:
        - provider
        - apiKey
      properties:
        provider:
          $ref: '#/components/schemas/StoredTranscriptionProvider'
        apiKey:
          type: string
          description: Your API key for that provider.
    MessageResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: true
        message:
          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
    StoredTranscriptionProvider:
      type: string
      enum:
        - assemblyai
        - deepgram
        - openai
    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:
    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
    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.