Audioscrape Knowledge Graph API

openapi: 3.2.0
info:
  title: Audioscrape Com Knowledge Graph API
  version: '2026-05-16'
  contact:
    name: Audioscrape
    url: https://www.audioscrape.com
    email: lukas@audioscrape.com
  license:
    name: ''
  description: 'Operations tagged Knowledge Graph 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: Knowledge Graph
  description: Named-entity search and trending topics
paths:
  /api/entities:
    get:
      tags:
      - Knowledge Graph
      summary: Search knowledge-graph entities
      description: Searches the knowledge-graph index for entities (people, organisations, places, topics, products) extracted from podcast content. Results are sorted by total mention count across the corpus.
      operationId: search_entities
      parameters:
      - name: q
        in: query
        description: Name prefix to search for
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Filter by entity type (e.g. `person`, `organization`, `place`)
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Max results (default 20, max 50)
        required: false
        schema:
          type: integer
          format: int64
      - name: dataset_id
        in: query
        description: Only entities mentioned in this dataset. The dataset must be in your visible scope (public, or in a workspace you belong to); otherwise 404.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Matching entities sorted by mention count
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySearchResponse'
        '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/entities/{entity_slug}:
    get:
      tags:
      - Knowledge Graph
      summary: Get entity detail
      description: 'Returns an entity (person, organisation, place, etc.) plus the episodes where it''s most mentioned. Useful for building topic-specific feeds: pin to an entity, watch which episodes mention it.'
      operationId: get_entity
      parameters:
      - name: entity_slug
        in: path
        description: URL slug from entity search results
        required: true
        schema:
          type: string
      - name: dataset_id
        in: query
        description: Only count/list episodes from this dataset. The dataset must be in your visible scope; otherwise 404.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Entity + most-mentioning episodes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDetail'
        '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: Entity not found
          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/trending:
    get:
      tags:
      - Knowledge Graph
      summary: Trending searches and entities
      description: Returns what's trending across Audioscrape in the last 7 days — most-searched queries and most-mentioned entities. Computed from anonymised search logs and live entity-mention counts.
      operationId: get_real_trending
      responses:
        '200':
          description: Top searches + top entities for the last 7 days
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrendingResponse'
        '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
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.
    EntitySearchResponse:
      type: object
      required:
      - entities
      - total
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/EntityDetail'
        total:
          type: integer
          format: int64
    TrendingResponse:
      type: object
      required:
      - trending_searches
      - trending_entities
      properties:
        trending_entities:
          type: array
          items:
            $ref: '#/components/schemas/TrendingEntity'
        trending_searches:
          type: array
          items:
            $ref: '#/components/schemas/TrendingSearch'
    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.
    EntityDetail:
      type: object
      required:
      - id
      - name
      - slug
      - entity_type
      - mention_count
      properties:
        description:
          type:
          - string
          - 'null'
        entity_type:
          type: string
        id:
          type: integer
          format: int64
        mention_count:
          type: integer
          format: int64
        name:
          type: string
        recent_episodes:
          type: array
          items:
            $ref: '#/components/schemas/EntityEpisodeMention'
          description: 'Top episodes mentioning this entity. Only populated by

            `GET /api/entities/{slug}` — search results

            (`GET /api/entities`) always return an empty list and the field

            is omitted from the JSON to keep responses compact.'
        slug:
          type: string
        wikidata_qid:
          type:
          - string
          - 'null'
          description: 'Wikidata QID for head entities (GH#161 linking) — the stable

            external join key. Omitted when unlinked (the long tail).'
    TrendingEntity:
      type: object
      required:
      - name
      - entity_type
      - slug
      - recent_mentions
      properties:
        entity_type:
          type: string
        name:
          type: string
        recent_mentions:
          type: integer
          format: int64
        slug:
          type: string
    TrendingSearch:
      type: object
      required:
      - query
      - search_count
      properties:
        query:
          type: string
        search_count:
          type: integer
          format: int64
    EntityEpisodeMention:
      type: object
      required:
      - episode_id
      - episode_title
      - podcast_title
      - mention_count
      properties:
        episode_id:
          type: integer
          format: int64
        episode_title:
          type: string
        mention_count:
          type: integer
          format: int64
        podcast_title:
          type: string
  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