Upload Call with Audio

Before You Start

You will need:

• Your Creovai instance name — the subdomain of your Creovai environment (e.g. alliedglobal in alliedglobal.audio.tethr.com)
• API credentials — a client ID and secret issued by Creovai Support. Contact support@creovai.com if you don't have these
• A valid recording file — WAV (PCM or uLaw), MP3, Ogg Opus, or M4A
• A tool capable of making HTTP requests

Authorization

Note: To request a bearer token, reference the Authorization Token article.

Archived Call

Please refer to https://docs.tethr.com/reference/post_capture-v2-call for full developer documentation.

Archived calls are uploaded as multipart form data as specified in rfc2388.

Endpoint

POST https://<<INSTANCE>>.audio.tethr.com/capture/v2/call

How It Works

The request is sent as multipart/form-data with exactly two parts:

Working Example — curl

curl --location 'https://<<INSTANCE>>.audio.tethr.com/capture/v2/call' \
--header 'Authorization: Bearer <<YOUR_TOKEN>>' \
--form 'info="{
    \"sessionId\": \"UNIQUE-SESSION-ID\",
    \"utcStart\": \"2026-07-16T09:00:00Z\",
    \"direction\": \"Outbound\",
    \"participants\": [
        {
            \"type\": \"Agent\",
            \"channel\": 0,
            \"referenceId\": \"agent@yourcompany.com\",
            \"firstName\": \"Jane\",
            \"lastName\": \"Smith\"
        },
        {
            \"type\": \"Customer\",
            \"channel\": 1,
            \"phoneNumber\": \"5555559876\",
            \"firstName\": \"John\",
            \"lastName\": \"Doe\"
        }
    ],
    \"metadata\": {
        \"key\": \"value\"
    }
}";type=application/json' \
--form 'data=@"/path/to/your/recording.wav"'

The info Object — Full Field Reference

Required fields

Optional fields

Participants

Each participant in the participants array represents one party on the call and maps to one audio channel in the recording.

Required per participant

Optional per participant

Audio File Requirements

Supported formats

File structure

The API expects a single audio file representing the entire call, including any hold periods or silence. The file should have one channel per participant.

Response

A successful upload returns 200 OK with the Creovai-assigned interaction ID:

{
    "id": "bbsnbcbe3",
        "masterId": null,
        "sessionId": "UNIQUE-SESSION-ID",
        "caseReferenceId": null,
    "collectionId": null
}

Store the id value. It is the primary identifier for this call in Creovai and is essential for troubleshooting. You can use it to link directly to the call in the UI:

https://<<INSTANCE>>.tethr.com/calls/<<id>>

Rate limit headers are returned on every response:

Error responses

Check Processing Status

After upload, you can check whether Creovai has finished processing the call using the session ID.

Endpoint:

POST https://<<INSTANCE>>.audio.tethr.com/capture/v2/status

Request:

{
    "SessionIds": ["UNIQUE-SESSION-ID"]
}

Response:

{
  "sessions": [
            {
                    "status": "Complete",
        "id": "bbsnbcbe3",
        "sessionId": "UNIQUE-SESSION-ID",         "durationSec": 0
            }
      ]
}

Status values:

You can query multiple session IDs in a single request by adding them to the array.

Composite Calls — masterId

If a single customer interaction is split across multiple recordings (e.g. due to a transfer or hold), you can link them in Creovai using a shared masterId.

Each recording must have its own unique sessionId, but they share the same masterId. Creovai will associate them as parts of the same interaction.

Example scenario:

• Customer calls in, agent picks up → recording starts (Session A)
• Agent puts call on hold → recording ends, audio file created
• Agent returns → new recording starts (Session B)
• Upload Session A and Session B both with the same masterId

Recording Settings (Optional)

If your integration needs to know which agents should have their calls sent to Creovai, you can retrieve the recording settings list:

GET https://<<INSTANCE>>.audio.tethr.com/sources/v1/recordingSettings
Authorization: Bearer <<YOUR_TOKEN>>

The response is an array of agents with a lookupId (typically matching an employee or extension ID) and a recordingSetting value of either None (record) or Disabled (do not record). If an agent's ID is not in the list, treat them as recordable.

This endpoint is optional — if your system already determines which calls to send without Creovai's settings, you do not need to use it.

Status Heartbeats (Optional)

If you are running a persistent integration service, you can send periodic heartbeat messages to Creovai to confirm it is running. Heartbeats should be sent approximately every 5 minutes.

POST https://<<INSTANCE>>.audio.tethr.com/capture/v2/monitor
Authorization: Bearer <<YOUR_TOKEN>>
Content-Type: application/json
{
    "status": "Healthy",
    "timeStamp": "2026-07-16T09:00:00Z",
    "name": "YOUR-SERVICE-NAME",
    "softwareVersion": "1.0.0"
}

Status values:

A successful heartbeat returns 204 No Content. A 404 response means heartbeats are not enabled for your environment.

SDKs

If you are building a .NET integration, a pre-built SDK is available:

• .NET SDK via NuGet: Tethr.AudioBroker
• .NET sample application: GitHub — CollabIP/Tethr.AudioBroker.SDK
• C++ SDK: GitHub — CollabIP/Tethr.AudioBroker.CPP.SDK

Articles in this section

• Archived Call Upload API
• Async Metadata API
• Call purge APIs
• Call Summary - Outbound Webhook
• Guest user token API
• Sending Chat interactions via Creovai API
• Token authentication API