Audioscrape Data Export API

openapi: 3.2.0
info:
  title: Audioscrape Com Data Export API
  version: '2026-05-16'
  contact:
    name: Audioscrape
    url: https://www.audioscrape.com
    email: lukas@audioscrape.com
  license:
    name: ''
  description: 'Operations tagged Data Export across 2 of this provider''s published API definitions: audioscrape-com-openapi.json, audioscrape-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.audioscrape.com
  description: Production
tags:
- name: Data Export
  description: Customer-initiated bulk export of workspace data (audio, transcripts, items, metadata) into a downloadable archive
paths:
  /api/workspaces/{workspace}/export:
    post:
      tags:
      - Data Export
      summary: Request an export of all workspace data
      description: 'Creates an asynchronous job to package the workspace''s audio files,

        transcripts, items, and metadata into a single downloadable archive.

        Only workspace `owner` or `admin` members may call this endpoint.


        At most one job per workspace can be in `queued` or `running` status at

        any time; further requests return `429` until the active job finishes.

        Poll `GET /api/workspaces/{workspace}/export/{job_id}` for status.'
      operationId: create_workspace_export
      parameters:
      - name: workspace
        in: path
        description: Workspace ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '201':
          description: Export job created and queued for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateExportJobResponse'
        '401':
          description: Missing or invalid session / key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '403':
          description: Caller is not an owner or admin of the workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '429':
          description: Another export for this workspace is already queued or running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
      security:
      - BearerAuth: []
    servers:
    - url: https://www.audioscrape.com
      description: Production
  /api/workspaces/{workspace}/export/{job_id}:
    get:
      tags:
      - Data Export
      summary: Poll the status of a workspace export job
      description: 'Returns the current lifecycle state of an export job. When `status` is

        `completed`, `download_url` is a signed URL valid for 15 minutes (until

        `download_expires_at`); each call signs a fresh one. A finished export

        stays downloadable for 7 days, after which `status` reads `expired`.


        Caller must be a member of the workspace (any role).'
      operationId: get_workspace_export
      parameters:
      - name: workspace
        in: path
        description: Workspace ID
        required: true
        schema:
          type: integer
          format: int64
      - name: job_id
        in: path
        description: Export job ID returned by POST /api/workspaces/{workspace}/export
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Current status of the export job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportJobStatus'
        '401':
          description: Missing or invalid session / key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '403':
          description: Caller is not a member of the workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '404':
          description: Workspace or job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
      security:
      - BearerAuth: []
    servers:
    - url: https://www.audioscrape.com
      description: Production
components:
  schemas:
    UsageInfo:
      type: object
      required:
      - current
      - limit
      properties:
        current:
          type: integer
          format: int64
          description: Current usage value (e.g., calls consumed this period).
        limit:
          type: integer
          format: int64
          description: Configured limit for the period.
    ApiErrorBody:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine-readable error code (UPPERCASE_SNAKE_CASE).
          example: SEARCH_LIMIT_EXCEEDED
        message:
          type: string
          description: Human-readable error message.
          example: Monthly search limit reached
        usage:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/UsageInfo'
            description: Present on rate-limit / quota errors. Omitted otherwise.
    CreateExportJobResponse:
      type: object
      description: Response from `POST /api/workspaces/{workspace}/export`.
      required:
      - job_id
      - status
      - status_url
      properties:
        job_id:
          type: integer
          format: int64
          description: Numeric ID of the newly created export job.
          example: 42
        status:
          type: string
          description: Always `"queued"` immediately after creation.
          example: queued
        status_url:
          type: string
          description: Relative URL clients should poll for status + the eventual download URL.
          example: /api/workspaces/17/export/42
    ExportJobStatus:
      type: object
      description: Response from `GET /api/workspaces/{workspace}/export/{job_id}`.
      required:
      - id
      - status
      properties:
        bytes:
          type:
          - integer
          - 'null'
          format: int64
          description: Total size of the generated archive in bytes. `null` until completion.
          example: 1572864000
        completed_at:
          type:
          - string
          - 'null'
          description: RFC 3339 UTC timestamp the job reached a terminal state. `null` while in flight.
          example: '2026-05-17T10:42:00Z'
        created_at:
          type:
          - string
          - 'null'
          description: RFC 3339 UTC timestamp the job was created.
          example: '2026-05-17T10:00:00Z'
        download_expires_at:
          type:
          - string
          - 'null'
          description: RFC 3339 UTC timestamp at which `download_url` stops working.
          example: '2026-05-17T10:57:00Z'
        download_url:
          type:
          - string
          - 'null'
          description: 'Signed download URL, valid for 15 minutes from this response. Present

            only when `status == "completed"`; poll the job again for a fresh one.

            A finished export stays downloadable for 7 days, then reads `expired`.'
          example: https://files.audioscrape.com/exports/abc.tar.gz?sig=...
        error_message:
          type:
          - string
          - 'null'
          description: Human-readable failure reason. Set only when `status == "failed"`.
          example: S3 upload timed out
        id:
          type: integer
          format: int64
          description: Numeric job ID.
          example: 42
        item_count:
          type:
          - integer
          - 'null'
          format: int32
          description: Number of items packaged in the export. `null` until completion.
          example: 1234
        status:
          type: string
          description: One of `queued`, `running`, `completed`, `failed`, `expired`.
          example: completed
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key, format `sk_<base64(32 random bytes)>`
      description: 'Workspace-scoped API key. Pass as `Authorization: Bearer <key>`. The `?api_key=<key>` query parameter is deprecated: a key in a URL ends up in browser history, proxy logs and Referer headers.'
x-refined-from:
- audioscrape-com-openapi.json
- audioscrape-com-openapi.json