AudioMap Ask API

openapi: 3.2.0
info:
  title: AudioMap Ask API
  version: 1.0.0
  description: 'Transcribe audio and video, then read, analyse and query it programmatically.


    Authentication: send an API key as `Authorization: Bearer am_live_...`.

    Create one at https://audiomap.ai/dashboard/api-keys. The key is shown once.

    A session JWT is NOT accepted here; only API keys.


    Plan: the REST API is included from the Pro plan up. Calls from a lower plan

    answer 403 `tier_upgrade_required` with the plan you need in `requiredTier`.


    Credits: writing operations spend monthly credits from the same balance as the

    MCP server. If an operation fails after being charged, the credits are refunded.

    Read `GET /v1/openapi.json` `x-audiomap-credits` for the current prices.


    There is also an MCP server at POST /mcp/stream with the same capabilities,

    for clients that speak Model Context Protocol. See GET /mcp/info.'
  contact:
    name: AudioMap
    url: https://audiomap.ai/developers
servers:
- url: https://api.audiomap.ai
security:
- apiKey: []
tags:
- name: ask
  description: Ask questions over one note or the whole library
paths:
  /v1/notes/{id}/ask:
    post:
      tags:
      - ask
      operationId: askNote
      summary: Ask a question about one note
      description: The answer quotes the audio as [mm:ss]; `citedSegments` carries the transcript segment ids the retrieval used.
      parameters:
      - $ref: '#/components/parameters/NoteId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - question
              properties:
                question:
                  type: string
                  minLength: 1
                  maxLength: 4000
      responses:
        '200':
          description: The answer with its citations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Answer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: Not enough credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: insufficient_credits
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The note is not ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: note_not_ready
        '429':
          $ref: '#/components/responses/RateLimited'
        '502':
          description: The model did not answer; credits were refunded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: chat_failed
  /v1/ask:
    post:
      tags:
      - ask
      operationId: askLibrary
      summary: Ask a question across every note you own
      description: Answers cite [Note title | mm:ss]. Pass the returned `sessionId` back to continue the same conversation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - question
              properties:
                question:
                  type: string
                  minLength: 1
                  maxLength: 4000
                sessionId:
                  type: string
                  format: uuid
      responses:
        '200':
          description: The answer with the notes it came from
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalAnswer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: Not enough credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: insufficient_credits
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '502':
          description: The model did not answer; credits were refunded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: chat_failed
components:
  responses:
    NotFound:
      description: No note with that id belongs to you
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: not_found
    RateLimited:
      description: Too many requests for this API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: rate_limit_exceeded
            retryAfter: 60
    Forbidden:
      description: Your plan does not include the REST API
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: tier_upgrade_required
            currentTier: personal
            requiredTier: pro
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_api_key
  schemas:
    GlobalAnswer:
      type: object
      properties:
        question:
          type: string
        answer:
          type: string
          description: Quotes as [Note title | mm:ss]
        citedSegments:
          type: array
          items:
            type: string
            format: uuid
        citedNotes:
          type: array
          items:
            type: object
            properties:
              noteId:
                type: string
                format: uuid
              title:
                type: string
        sessionId:
          type: string
          format: uuid
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Stable machine-readable code
        message:
          type: string
          description: Human-readable explanation
      additionalProperties: true
    Answer:
      type: object
      properties:
        noteId:
          type: string
          format: uuid
        question:
          type: string
        answer:
          type: string
          description: Quotes the audio as [mm:ss]
        citedSegments:
          type: array
          items:
            type: string
            format: uuid
  parameters:
    NoteId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An AudioMap API key: `Authorization: Bearer am_live_...`'
x-audiomap-credits:
  description: Credit cost per operation. Read operations are free unless listed here.
  costs:
    POST /v1/notes (audioUrl): 50
    GET /v1/notes/{id}/transcript: 1
    POST /v1/notes/{id}/analysis: 100 per template
    GET /v1/notes/{id}/outline?generate=1: 50
    POST /v1/notes/{id}/ask: 10
    POST /v1/notes/{id}/transcript/translation: 0 the first time per note and language
    POST /v1/ask: 10
    POST /v1/notes/{id}/deliverables: 300
  monthlyByPlan:
    free: 200
    personal: 1000
    pro: 5000
    power: 25000
    team: 5000
x-audiomap-deliverable-templates:
  email:
  - follow_up
  - recap
  - next_steps
  - thank_you
  document:
  - project_brief
  - meeting_recap
  - fiscal_revision
  - legal_acta
  - medical_consult
  slides:
  - exec_summary
  - kickoff
  - recap_visual
  - sales_pitch_es