Audioscrape Workspaces API

openapi: 3.2.0
info:
  title: Audioscrape Com Workspaces API
  version: '2026-05-16'
  contact:
    name: Audioscrape
    url: https://www.audioscrape.com
    email: lukas@audioscrape.com
  license:
    name: ''
  description: 'Operations tagged Workspaces 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: Workspaces
  description: 'The canonical tenant surface: your workspace and its datasets, private included. Members-only — workspaces you don''t belong to are 404s here; browse other people''s published content via Libraries.'
paths:
  /api/workspaces:
    get:
      tags:
      - Workspaces
      summary: List your workspaces
      description: Returns every workspace the calling user is a member of, with the caller's role in each. `is_current` marks the workspace the authenticating API key (or session) is scoped to. Ordered current-first, then by name.
      operationId: list_workspaces
      responses:
        '200':
          description: Workspaces the calling user belongs to
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceList'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '402':
          description: No active subscription (paid endpoint requires a subscription)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '403':
          description: Endpoint not available on the caller's plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '429':
          description: 'Monthly quota exhausted (response includes `usage: { current, limit }`)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
      security:
      - BearerAuth: []
    servers:
    - url: https://www.audioscrape.com
      description: Production
  /api/workspaces/{workspace}:
    get:
      tags:
      - Workspaces
      summary: Get workspace detail
      description: 'Returns one of your workspaces + ALL of its datasets regardless of visibility — including private datasets that never appear under `/api/libraries`. `{workspace}` accepts a slug or a numeric ID. Members only: a workspace you don''t belong to returns 404.'
      operationId: get_workspace
      parameters:
      - name: workspace
        in: path
        description: Workspace slug (e.g. `audioscrape`) or numeric workspace ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workspace + all its datasets (private included)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceDetail'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '402':
          description: No active subscription (paid endpoint requires a subscription)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '403':
          description: Endpoint not available on the caller's plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '404':
          description: Workspace not found, or caller is not a member
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '429':
          description: 'Monthly quota exhausted (response includes `usage: { current, limit }`)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
      security:
      - BearerAuth: []
    servers:
    - url: https://www.audioscrape.com
      description: Production
  /api/workspaces/{workspace}/datasets:
    get:
      tags:
      - Workspaces
      summary: List workspace datasets
      description: Returns every dataset in one of your workspaces — `public`, `workspace`, and `private` alike. Same `{workspace}` resolution (slug or numeric ID) and members-only access rules as `GET /api/workspaces/{workspace}`.
      operationId: list_workspace_datasets
      parameters:
      - name: workspace
        in: path
        description: Workspace slug (e.g. `audioscrape`) or numeric workspace ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: All datasets in the workspace, ordered by ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetList'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '402':
          description: No active subscription (paid endpoint requires a subscription)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '403':
          description: Endpoint not available on the caller's plan
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '404':
          description: Workspace not found, or caller is not a member
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
        '429':
          description: 'Monthly quota exhausted (response includes `usage: { current, limit }`)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorBody'
      security:
      - BearerAuth: []
    servers:
    - url: https://www.audioscrape.com
      description: Production
components:
  schemas:
    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.
    WorkspaceDetail:
      type: object
      required:
      - id
      - slug
      - name
      - role
      - member_count
      - datasets
      properties:
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/DatasetSummary'
          description: ALL of the workspace's datasets — `public`, `workspace`, and `private`.
        description:
          type:
          - string
          - 'null'
        id:
          type: integer
          format: int64
        member_count:
          type: integer
          format: int64
        name:
          type: string
        role:
          type: string
          description: 'The calling user''s role in this workspace: `owner`, `admin`, or `member`.'
        slug:
          type: string
    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.
    WorkspaceList:
      type: object
      required:
      - workspaces
      - total
      properties:
        total:
          type: integer
          format: int64
        workspaces:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceSummary'
    WorkspaceSummary:
      type: object
      required:
      - id
      - slug
      - name
      - role
      - member_count
      - is_current
      properties:
        description:
          type:
          - string
          - 'null'
        id:
          type: integer
          format: int64
        is_current:
          type: boolean
          description: 'Whether this is the workspace the authenticating API key (or session)

            is scoped to — the one searches, uploads, and quotas run against.'
        member_count:
          type: integer
          format: int64
        name:
          type: string
        role:
          type: string
          description: 'The calling user''s role in this workspace: `owner`, `admin`, or `member`.'
        slug:
          type: string
          description: Stable URL slug, e.g. `audioscrape`.
    DatasetSummary:
      type: object
      required:
      - id
      - slug
      - name
      - visibility
      - podcast_count
      - episode_count
      properties:
        description:
          type:
          - string
          - 'null'
        episode_count:
          type: integer
          format: int64
        id:
          type: integer
          format: int64
        name:
          type: string
        podcast_count:
          type: integer
          format: int64
        slug:
          type: string
        visibility:
          type: string
          description: '`public`, `workspace`, or `private`.'
    DatasetList:
      type: object
      required:
      - datasets
      - total
      properties:
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/DatasetSummary'
        total:
          type: integer
          format: int64
  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