Audio

    Upload and download audio recordings from mapping and testing runs.

    5 endpoints

    POST/audio/upload-url

    Generate a pre-signed URL for uploading an audio file to S3.

    Body Parameters

    NameTypeRequiredDescription
    fileNamestringrequiredName of the audio file
    contentTypestringrequiredMIME type (e.g., audio/wav, audio/mp3)

    Request

    bash
    curl -X POST -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"fileName":"recording.wav","contentType":"audio/wav"}' \
      https://api.nopaque.co.uk/audio/upload-url

    Response

    json
    {
      "uploadUrl": "https://s3.eu-west-2.amazonaws.com/...",
      "audioId": "aud_abc123",
      "expiresIn": 3600
    }
    GET/audio/download-url

    Generate a pre-signed URL for downloading an audio file.

    Query Parameters

    NameTypeRequiredDescription
    audioIdstringrequiredAudio file ID

    Request

    bash
    curl -H "x-api-key: YOUR_API_KEY" \
      "https://api.nopaque.co.uk/audio/download-url?audioId=aud_abc123"

    Response

    json
    {
      "downloadUrl": "https://s3.eu-west-2.amazonaws.com/...",
      "expiresIn": 3600
    }
    GET/audio

    List all audio files in the workspace.

    Query Parameters

    NameTypeRequiredDescription
    limitnumberoptionalMaximum items to return (default 50)
    nextTokenstringoptionalPagination token from previous response

    Request

    bash
    curl -H "x-api-key: YOUR_API_KEY" \
      https://api.nopaque.co.uk/audio

    Response

    json
    {
      "audioFiles": [
        {
          "id": "aud_abc123",
          "fileName": "recording.wav",
          "contentType": "audio/wav",
          "createdAt": "2026-04-10T12: 00: 00Z"
        }
      ],
      "count": 1
    }
    GET/audio/{id}

    Get metadata for a specific audio file.

    Path Parameters

    NameTypeRequiredDescription
    idstringrequiredAudio file ID

    Request

    bash
    curl -H "x-api-key: YOUR_API_KEY" \
      https://api.nopaque.co.uk/audio/aud_abc123

    Response

    json
    {
      "id": "aud_abc123",
      "fileName": "recording.wav",
      "contentType": "audio/wav",
      "sizeBytes": 1048576,
      "createdAt": "2026-04-10T12: 00: 00Z"
    }
    DELETE/audio/{id}

    Delete an audio file and its S3 object.

    Path Parameters

    NameTypeRequiredDescription
    idstringrequiredAudio file ID

    Request

    bash
    curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
      https://api.nopaque.co.uk/audio/aud_abc123

    Response

    json
    {
      "message": "Audio file deleted successfully"
    }