Back to top

API Documentation

Transcriptions

Overview

Transcriptions are structured records of transcribed conversations (e.g. voice calls or meetings). A transcription belongs to a brand and may optionally be linked to a contact, a deal, and an audio file.

This is the canonical replacement for storing free-form transcripts in contact note attributes.

Transcription

A Transcription's data model is described in the table below:

Field Type Association Description
id uuid Internal identifier of the object
created_at number Unix timestamp of creation
updated_at number Unix timestamp of last update
brand uuid The brand this transcription belongs to
user User transcription.user The user who recorded/owns this transcription
contact Contact transcription.contact Optional contact this conversation is with
deal Deal transcription.deal Optional deal this conversation is about
audio File transcription.audio Optional uploaded audio file for this recording
summary string Summary of the transcript, supplied by the client or generated by the server (see Summaries). Client summaries are saved unchanged and may contain HTML; server-generated summaries use Markdown.
text string Convenience field: a readable transcript built from entries in position order. Adjacent entries are separated by a single space, except a newline is inserted after an entry that ends with terminal punctuation (., !, ?, optionally followed by closing quotes or brackets) when the gap to the next entry’s timestamp is at least 1.2s. Entries with no timestamp fall back to newline separation. null when there are no entries. Always returned without requesting transcription.entries.
entries Utterance[] transcription.entries Ordered list of transcribed utterances (see below)
created_by uuid User who created this record
updated_by uuid User who last updated this record

Summaries

A non-empty summary supplied when creating a transcription is saved unchanged and returned immediately. When summary is omitted, null, or an empty string and contents is non-empty, the server generates a summary from the transcript in the background. It’s usually ready a few seconds after the request returns, so clients should refetch the transcription to get it. On a new transcription awaiting generation, summary is null until then.

Server-generated summaries use Markdown with up to three sections, each left out when empty:

## Overview
The buyers are relocating in March and need three bedrooms near good schools.

## Key Points
- Pre-approved up to $520k, prefer to stay around $480k.

## Action Items
- Send listings in Frisco and Allen by Thursday.

On PUT, a non-empty summary in the request is saved unchanged, including when the request also replaces contents, and that request does not queue summary generation. Replacing contents with a non-empty list without a non-empty summary in the request generates a new summary from the new transcript. Updating only summary saves or clears it without generating a new one.

Utterance

Each entry of contents is an object describing a single line of the conversation:

Field Type Required Description
timestamp number no Offset from the start of the conversation, in seconds. Fractional values are allowed.
author string no Free-form speaker label (e.g. Agent, Client, or a name).
text string yes The transcribed text for this utterance.

Endpoints

List transcriptions for a brand

List transcriptions for a brand
GET/brands/:id/transcriptions

Returns all transcriptions belonging to the brand, ordered most-recent-first. Optionally filter by contact, deal, or both.

Query parameters:

Field Type Required Description
contact uuid no When provided, only transcriptions for this contact are returned.
deal uuid no When provided, only transcriptions for this deal are returned.

Example URI

GET /brands/:id/transcriptions
URI Parameters
HideShow
id
string (required) Example: af002791-d50a-43a0-a56b-ef0deac9a51b
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "created_at": 1791656562.634484,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "updated_by": null,
      "summary": "## Overview\nMock summary of a 19-word memo.\n\n## Key Points\n- Agent: Hi, how can I help you?",
      "type": "transcription",
      "entries": [
        {
          "id": "87abfc1f-b5b4-40c5-9292-7521b97842b0",
          "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
          "position": 0,
          "timestamp": 0,
          "author": "Agent",
          "text": "Hi, how can I help you?",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "667ac356-7709-4f6e-97bc-527ceedccb62",
          "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
          "position": 1,
          "timestamp": 3.5,
          "author": "Client",
          "text": "Looking for a 3-bedroom house.",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "b3776d2a-3f38-423f-aaf9-d08bc538a7e2",
          "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
          "position": 2,
          "timestamp": 7.2,
          "author": "Agent",
          "text": "Great, what is your budget?",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        }
      ],
      "text": "Hi, how can I help you?\nLooking for a 3-bedroom house.\nGreat, what is your budget?"
    },
    {
      "id": "949c8dbe-7300-4ee9-abad-40fac5fa7de6",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "created_at": 1791656562.634484,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "updated_by": null,
      "summary": "<p>Buyer wants a 3-bedroom house under <strong>$500k</strong>.</p>",
      "type": "transcription",
      "entries": [
        {
          "id": "11948319-d8e8-4cfa-b1f1-916274312240",
          "transcription": "949c8dbe-7300-4ee9-abad-40fac5fa7de6",
          "position": 0,
          "timestamp": null,
          "author": null,
          "text": "Hi, how can I help you?",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "ee8d3b98-2884-4de4-8c85-dcee0a664240",
          "transcription": "949c8dbe-7300-4ee9-abad-40fac5fa7de6",
          "position": 1,
          "timestamp": null,
          "author": null,
          "text": "Looking for a 3-bedroom house.",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        }
      ],
      "text": "Hi, how can I help you?Looking for a 3-bedroom house."
    },
    {
      "id": "b4394fd4-30ab-4d63-89f2-4a4b2e60ffdb",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "created_at": 1791656562.634484,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "updated_by": null,
      "summary": "## Overview\nMock summary of a 11-word memo.\n\n## Key Points\n- Agent: What is your budget?",
      "type": "transcription",
      "entries": [
        {
          "id": "2b5c4696-7b4e-4135-8316-f2e0a42a7cf9",
          "transcription": "b4394fd4-30ab-4d63-89f2-4a4b2e60ffdb",
          "position": 0,
          "timestamp": 0,
          "author": "Agent",
          "text": "What is your budget?",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "5d6f37da-1821-4450-8317-f288ab853ad6",
          "transcription": "b4394fd4-30ab-4d63-89f2-4a4b2e60ffdb",
          "position": 1,
          "timestamp": 2.1,
          "author": "Client",
          "text": "Around $500k, ideally in Plano.",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        }
      ],
      "text": "What is your budget?\nAround $500k, ideally in Plano."
    },
    {
      "id": "36b05ba8-0b30-4e65-a4fe-fdf25bd5335c",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "created_at": 1791656562.634484,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "updated_by": null,
      "summary": "## Overview\nMock summary of a 7-word memo.\n\n## Key Points\n- Older device transcript with no utterance metadata.",
      "type": "transcription",
      "entries": [
        {
          "id": "c9179227-dd7f-41cc-ad8f-353c97a67eaa",
          "transcription": "36b05ba8-0b30-4e65-a4fe-fdf25bd5335c",
          "position": 0,
          "timestamp": null,
          "author": null,
          "text": "Older device transcript with no utterance metadata.",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        }
      ],
      "text": "Older device transcript with no utterance metadata."
    },
    {
      "id": "b4afcfcd-99d4-433c-9e4d-200c3c330361",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "created_at": 1791656562.634484,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "updated_by": null,
      "summary": "## Overview\nMock summary of a 4-word memo.\n\n## Key Points\n- Metadata can be null.",
      "type": "transcription",
      "entries": [
        {
          "id": "65470b0b-bce0-43d7-8a4b-c97ffc9bcca9",
          "transcription": "b4afcfcd-99d4-433c-9e4d-200c3c330361",
          "position": 0,
          "timestamp": null,
          "author": null,
          "text": "Metadata can be null.",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        }
      ],
      "text": "Metadata can be null."
    },
    {
      "id": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "created_at": 1791656562.634484,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "updated_by": null,
      "summary": "## Overview\nMock summary of a 11-word memo.\n\n## Key Points\n- Agent: Hi there.",
      "type": "transcription",
      "entries": [
        {
          "id": "33474076-cc02-442c-b370-5dd6bb530aaf",
          "transcription": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
          "position": 0,
          "timestamp": 0,
          "author": "Agent",
          "text": "Hi",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "820d6769-1615-4781-b6de-633a4d20f886",
          "transcription": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
          "position": 1,
          "timestamp": 0.3,
          "author": "Agent",
          "text": "there.",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "39f34d53-5374-4b65-aa4e-cce3631af850",
          "transcription": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
          "position": 2,
          "timestamp": 2.5,
          "author": "Client",
          "text": "How",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "aa418865-eb57-419c-9db8-b94756750d9e",
          "transcription": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
          "position": 3,
          "timestamp": 2.8,
          "author": "Client",
          "text": "are",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "7db9e5d3-f475-4bd7-a856-0bd9a86f3e89",
          "transcription": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
          "position": 4,
          "timestamp": 3,
          "author": "Client",
          "text": "you?",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "3b230e92-98da-4c11-a5b8-9a69e21aa4bb",
          "transcription": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
          "position": 5,
          "timestamp": 5,
          "author": "Agent",
          "text": "I",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "0f648ff4-3134-4428-b318-1f20166a34b6",
          "transcription": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
          "position": 6,
          "timestamp": 5.2,
          "author": "Agent",
          "text": "am",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        },
        {
          "id": "3369be8b-c7d7-423f-a66e-82ab328c5f94",
          "transcription": "7783ab98-c0b9-4bb4-a431-a47d3d0cacec",
          "position": 7,
          "timestamp": 5.5,
          "author": "Agent",
          "text": "great.",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        }
      ],
      "text": "Hi there.\nHow are you?\nI am great."
    },
    {
      "id": "e7c2fff1-6704-4206-9183-3c74c5fcfe17",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "created_at": 1791656562.634484,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "updated_by": null,
      "summary": null,
      "type": "transcription",
      "entries": null,
      "text": null
    },
    {
      "id": "c526d59b-e6c4-4934-bf24-cf4223415d46",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "created_at": 1791656562.634484,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "updated_by": null,
      "summary": "## Overview\nMock summary of a 5-word memo.\n\n## Key Points\n- Deal recording without a contact.",
      "type": "transcription",
      "entries": [
        {
          "id": "f2a1f7c7-b35b-4663-8fc7-11387b3ed667",
          "transcription": "c526d59b-e6c4-4934-bf24-cf4223415d46",
          "position": 0,
          "timestamp": null,
          "author": null,
          "text": "Deal recording without a contact.",
          "created_at": 1791656562.634484,
          "deleted_at": null,
          "type": "transcription_entry"
        }
      ],
      "text": "Deal recording without a contact."
    }
  ],
  "info": {
    "count": 8,
    "total": 0
  }
}

Get a specific transcription

Get a specific transcription
GET/brands/:id/transcriptions/:transcription

Example URI

GET /brands/:id/transcriptions/:transcription
URI Parameters
HideShow
id
string (required) Example: af002791-d50a-43a0-a56b-ef0deac9a51b
transcription
string (required) Example: 97a8a269-1820-423c-97c2-b5a2d9ad2008
associations
string (required) Example: transcription.contact
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
    "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
    "contact": {
      "id": "fc716cbc-33a4-4caf-8d87-d3088b48e3ed",
      "display_name": "Johnny",
      "partner_name": "Jane Doe",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "brand_id": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "user_id": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "sort_field": "Johnny",
      "last_touch": null,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1791656563.108437,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_for": "direct_request",
      "updated_for": "direct_request",
      "deleted_for": null,
      "title": null,
      "first_name": "John",
      "partner_first_name": "Jane",
      "middle_name": "M.",
      "last_name": "Doe",
      "partner_last_name": "Doe",
      "marketing_name": null,
      "nickname": "Johnny",
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": "[email protected]",
      "phone_number": "+989124834198",
      "primary_phone_number": "+989124834198",
      "phone_numbers": [
        "+989124834198"
      ],
      "company": "Rechat",
      "birthday": "1970-01-12T00:00:00.000Z",
      "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "job_title": "Contact Test Subject",
      "source_type": "ExplicitlyCreated",
      "source": null,
      "website": [
        "http://www.gholi.com"
      ],
      "tags": [
        "poo",
        "foo",
        "New"
      ],
      "address": [
        {
          "city": "Dallas",
          "full": "Street, Dallas Texas 72890",
          "name": "Street",
          "type": "stdaddr",
          "extra": "Office",
          "line1": "Street",
          "line2": "Dallas Texas 72890",
          "state": "Texas",
          "country": "US",
          "postcode": "72890"
        }
      ],
      "type": "contact"
    },
    "created_at": 1791656562.634484,
    "updated_at": 1791656562.634484,
    "deleted_at": null,
    "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
    "updated_by": null,
    "summary": "## Overview\nMock summary of a 19-word memo.\n\n## Key Points\n- Agent: Hi, how can I help you?",
    "type": "transcription",
    "entries": [
      {
        "id": "87abfc1f-b5b4-40c5-9292-7521b97842b0",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 0,
        "timestamp": 0,
        "author": "Agent",
        "text": "Hi, how can I help you?",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      },
      {
        "id": "667ac356-7709-4f6e-97bc-527ceedccb62",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 1,
        "timestamp": 3.5,
        "author": "Client",
        "text": "Looking for a 3-bedroom house.",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      },
      {
        "id": "b3776d2a-3f38-423f-aaf9-d08bc538a7e2",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 2,
        "timestamp": 7.2,
        "author": "Agent",
        "text": "Great, what is your budget?",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      }
    ],
    "text": "Hi, how can I help you?\nLooking for a 3-bedroom house.\nGreat, what is your budget?"
  }
}

Create a transcription

Create a transcription
POST/brands/:id/transcriptions

Creates a transcription under the given brand. The optional contact and deal must belong to the same brand, and audio must reference an accessible uploaded file. The contents array may be empty, but every entry must include text. A non-empty summary is saved unchanged. Otherwise, the server generates a summary from non-empty contents in the background (see Summaries).

Body fields:

Field Type Required Description
contact uuid no Optional contact this conversation was with
deal uuid no Optional deal this conversation was about
audio uuid no Optional audio file id
summary string no Optional client-generated summary. A non-empty value is saved unchanged and skips server generation; omitted, null, or empty-string values allow generation from non-empty contents.
contents Utterance[] yes Ordered list of utterances (may be empty)

Example URI

POST /brands/:id/transcriptions
URI Parameters
HideShow
id
string (required) Example: af002791-d50a-43a0-a56b-ef0deac9a51b
associations
string (required) Example: transcription.contact,transcription.entries
Request
HideShow
Body
{
  "contact": "fc716cbc-33a4-4caf-8d87-d3088b48e3ed",
  "contents": [
    {
      "timestamp": 0,
      "author": "Agent",
      "text": "Hi, how can I help you?"
    },
    {
      "timestamp": 3.5,
      "author": "Client",
      "text": "Looking for a 3-bedroom house."
    },
    {
      "timestamp": 7.2,
      "author": "Agent",
      "text": "Great, what is your budget?"
    }
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
    "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
    "contact": {
      "id": "fc716cbc-33a4-4caf-8d87-d3088b48e3ed",
      "display_name": "Johnny",
      "partner_name": "Jane Doe",
      "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "brand_id": "af002791-d50a-43a0-a56b-ef0deac9a51b",
      "user_id": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
      "sort_field": "Johnny",
      "last_touch": null,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1791656563.108437,
      "updated_at": 1791656562.634484,
      "deleted_at": null,
      "created_for": "direct_request",
      "updated_for": "direct_request",
      "deleted_for": null,
      "title": null,
      "first_name": "John",
      "partner_first_name": "Jane",
      "middle_name": "M.",
      "last_name": "Doe",
      "partner_last_name": "Doe",
      "marketing_name": null,
      "nickname": "Johnny",
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": "[email protected]",
      "phone_number": "+989124834198",
      "primary_phone_number": "+989124834198",
      "phone_numbers": [
        "+989124834198"
      ],
      "company": "Rechat",
      "birthday": "1970-01-12T00:00:00.000Z",
      "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
      "job_title": "Contact Test Subject",
      "source_type": "ExplicitlyCreated",
      "source": null,
      "website": [
        "http://www.gholi.com"
      ],
      "tags": [
        "poo",
        "foo",
        "New"
      ],
      "address": [
        {
          "city": "Dallas",
          "full": "Street, Dallas Texas 72890",
          "name": "Street",
          "type": "stdaddr",
          "extra": "Office",
          "line1": "Street",
          "line2": "Dallas Texas 72890",
          "state": "Texas",
          "country": "US",
          "postcode": "72890"
        }
      ],
      "type": "contact"
    },
    "created_at": 1791656562.634484,
    "updated_at": 1791656562.634484,
    "deleted_at": null,
    "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
    "updated_by": null,
    "summary": null,
    "type": "transcription",
    "entries": [
      {
        "id": "87abfc1f-b5b4-40c5-9292-7521b97842b0",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 0,
        "timestamp": 0,
        "author": "Agent",
        "text": "Hi, how can I help you?",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      },
      {
        "id": "667ac356-7709-4f6e-97bc-527ceedccb62",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 1,
        "timestamp": 3.5,
        "author": "Client",
        "text": "Looking for a 3-bedroom house.",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      },
      {
        "id": "b3776d2a-3f38-423f-aaf9-d08bc538a7e2",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 2,
        "timestamp": 7.2,
        "author": "Agent",
        "text": "Great, what is your budget?",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      }
    ],
    "text": "Hi, how can I help you?\nLooking for a 3-bedroom house.\nGreat, what is your budget?"
  }
}

Update a transcription

Update a transcription
PUT/brands/:id/transcriptions/:transcription

Partially updates a transcription. All body fields are optional; only the fields you include are touched. Pass null (or [] for contents) to clear a field. When contents is provided, the existing entries are soft-deleted and replaced with the new ones. A non-empty contents regenerates the summary unless the request also supplies a non-empty summary, which is saved unchanged.

Body fields:

Field Type Required Description
summary string no Sets or clears the summary (e.g. a user edit). Pass null to clear. A non-empty value skips generation even when contents is replaced. Updating only summary does not generate a new one.
contents Utterance[] no If provided, replaces all entries with this new ordered list.
contact uuid no Re-link to a different contact, or null to unlink.
deal uuid no Re-link to a different deal, or null to unlink.
audio uuid no Re-link to a different audio file, or null to unlink.

Example URI

PUT /brands/:id/transcriptions/:transcription
URI Parameters
HideShow
id
string (required) Example: af002791-d50a-43a0-a56b-ef0deac9a51b
transcription
string (required) Example: 97a8a269-1820-423c-97c2-b5a2d9ad2008
Request
HideShow
Body
{
  "summary": "<p>Updated summary after the agent reviewed the call.</p>"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
    "brand": "af002791-d50a-43a0-a56b-ef0deac9a51b",
    "created_at": 1791656562.634484,
    "updated_at": 1791656562.634484,
    "deleted_at": null,
    "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
    "updated_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
    "summary": "<p>Updated summary after the agent reviewed the call.</p>",
    "type": "transcription",
    "entries": [
      {
        "id": "87abfc1f-b5b4-40c5-9292-7521b97842b0",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 0,
        "timestamp": 0,
        "author": "Agent",
        "text": "Hi, how can I help you?",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      },
      {
        "id": "667ac356-7709-4f6e-97bc-527ceedccb62",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 1,
        "timestamp": 3.5,
        "author": "Client",
        "text": "Looking for a 3-bedroom house.",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      },
      {
        "id": "b3776d2a-3f38-423f-aaf9-d08bc538a7e2",
        "transcription": "97a8a269-1820-423c-97c2-b5a2d9ad2008",
        "position": 2,
        "timestamp": 7.2,
        "author": "Agent",
        "text": "Great, what is your budget?",
        "created_at": 1791656562.634484,
        "deleted_at": null,
        "type": "transcription_entry"
      }
    ],
    "text": "Hi, how can I help you?\nLooking for a 3-bedroom house.\nGreat, what is your budget?"
  }
}

Upload transcription audio

Upload transcription audio
POST/brands/:id/transcriptions/audio

Uploads or imports an audio file for later use as audio in POST /brands/:id/transcriptions. Supports multipart uploads, copying an existing file, or importing { url, filename } with common audio extensions such as m4a, mp3, wav, and aac.

Example URI

POST /brands/:id/transcriptions/audio
URI Parameters
HideShow
id
string (required) Example: af002791-d50a-43a0-a56b-ef0deac9a51b
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "f4d2fb6d-a11b-48e9-ad59-ad86461f21f7",
    "created_at": 1791656563.415716,
    "updated_at": 1791656563.415716,
    "deleted_at": null,
    "created_by": "04f47f2c-e566-4ee7-bd61-ad305c772f68",
    "path": "transcriptions/af002791-d50a-43a0-a56b-ef0deac9a51b/audio/95b90760-c4d7-11f1-89da-fb554657817f.mp3",
    "name": "sample.mp3",
    "public": false,
    "type": "file",
    "url": "https://private-cdn.irish.rechat.com/transcriptions/af002791-d50a-43a0-a56b-ef0deac9a51b/audio/95b90760-c4d7-11f1-89da-fb554657817f.mp3?Expires=1791742963417&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=AQ2SWhXx3BbA9SDJF2eu4Le7rPqI1AfDYENSFyA0cjS5VU2gUn9-QpzD8B-OAZiSc-NBE9PJmlTUWDHcMAc7IR7d~69XhQmX5ASR392fwSIGgIWnOIoI5E2ejovWJIRtfMa3mXn55mUZRzMdyjTQM3KoyltZqg8~GIMiMhYLvz2NfbjWRE9LH61wv7xDIArygvqzmviu5n~byHX7ORuvfvUD7TO35cI2zWyBM6IVX6mjIGPL7vFa-cOLJdxLlJTahZmnuh-Snl32hV7sUMRdUD3UzxdbVPsWrNlc1baSuZtngOnziar05OxBuZP7ZUuYmkWZyOj9QYLWW4fGLpbvCA__",
    "preview_url": "http://assets.rechat.com/mimes/unknown.png",
    "mime": "audio/mpeg"
  }
}

Delete a transcription

Delete a transcription
DELETE/brands/:id/transcriptions/:transcription

Soft-deletes a transcription. Returns 204 on success.

Example URI

DELETE /brands/:id/transcriptions/:transcription
URI Parameters
HideShow
id
string (required) Example: af002791-d50a-43a0-a56b-ef0deac9a51b
transcription
string (required) Example: 97a8a269-1820-423c-97c2-b5a2d9ad2008
Response  204

Generated by aglio on 10 Oct 2026