{"openapi":"3.0.4","info":{"title":"Kenso API: Voice notes","version":"1.1","description":"The Voice notes endpoints of the Kenso API, with every component they use. The full spec is https://api.ken.so/v1/docs/openapi.json. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`."},"servers":[{"url":"https://api.ken.so"}],"security":[{"Bearer":[]}],"tags":[{"name":"voice-notes","description":"Voice notes are the audio messages Kenso records for a contact: the LinkedIn notes a voice note step records, and the iMessage notes Ken writes and speaks for a person who replied on iMessage (`POST /v1/voice-notes`, while the workspace's `imessage` feature is on). Touches show each note as a `voiceNote` object with its status, and with an `audioUrl` while its audio is stored, and LinkedIn thread messages and the LinkedIn messages in account activity show their notes the same way. An iMessage thread message names its note in `imessage.voiceNoteId` instead, and `GET /v1/voice-notes/{voiceNoteId}/imessage-audio` plays it, whether a member or a workflow sent it. `GET /v1/voice-notes/{voiceNoteId}` reads only a note made with `POST /v1/voice-notes` (its status and the touch or thread it was made for): any other note is `404`. Play the audio with this section's calls.","x-displayName":"Voice notes"}],"paths":{"/v1/voice-notes":{"post":{"tags":["voice-notes"],"summary":"Make an iMessage voice note for a person.","description":"Ken writes a voice note for the person and Kenso speaks it in `voice` right away. Nothing is sent. A member\nsends the note as the `voiceNoteId` of a reply on the person's iMessage thread\n(`POST /v1/threads/{threadId}/messages`). An agent or an API key sends it on one of the person's iMessage\ntouches instead (make it with `touchId`, or set the touch's `voiceNoteId`), which a member approves: a\nreply that carries a `voiceNoteId` from an agent or an API key is refused with `403 forbidden`\n(`imessage_agent_voice_note`). Only a person who replied in an iMessage thread can get one, and an SMS thread\ncarries text only. The note costs credits (`imessage_voice_note`), which count toward your monthly credit limit\nin the workspace.\n            \nPass `touchId` to make the note for one of the person's iMessage touches. The note is then judged on the\nthread that touch goes on (a reply's own thread, else its thread on the line the touch sends from; a warm path hop's,\non its approver's line), and Ken writes it on that thread's messages. The note names only its touch, not that\nthread. The touch shows it in `imessage.voiceNoteInProgress` while it is being made, and a call for a touch\nwhose note is still being made returns that note (status `generating`) without making or charging another.\nWhen the note is ready it goes on the touch as its `voiceNoteId`, as your own edit of the touch, if the touch\nis still open (planned, drafted, awaiting approval or failed), carries no images and has no voice note, and nobody\nchanged it while the note was made, even when you stopped waiting for this call. Otherwise the note is kept, and\ncharged, for you to put on a touch yourself, unless the touch was sent, skipped or deleted meanwhile: then the note\nfails with `touch_ended` and is not charged.\n            \nPass `threadId` (a `thr_` id) to make the note for one of the person's iMessage threads, such as the one\na member has open in the inbox to reply with it. The note is then judged on that thread instead of the person's latest iMessage thread, the thread\nshows it in `imessage.voiceNoteInProgress` while it is being made, and a call for a thread whose note is still\nbeing made returns that note (status `generating`) without making or charging another. Send `touchId` or\n`threadId`, not both. With neither, the note is made for the latest thread on the person's mobile number: it is\njudged on that thread, its `threadId` is that thread, and a call while that thread's note is still being made\nreturns that note.\n            \nThe note is made for iMessage: it goes only on an iMessage text, never on a LinkedIn, Facebook or WhatsApp message.\n            \nReturns `201` with the voice note: status `ready` with its `audioUrl`, or `failed` with its\n`failureReason` when the note could not be finished (or `generating` for a note already being made). The\ncall waits while the note is made. The note names the `touchId` or the `threadId` it was made for (with\nneither sent, the person's latest thread), the member who asked for it (`createdByMemberId`), and\n`createdAt` and `readyAt`, as `GET /v1/voice-notes/{voiceNoteId}` returns them. When the call timed\nout on your side, the thread's `imessage.voiceNoteInProgress` or `imessage.voiceNoteReady` names the note.\n            \nErrors:\n            \n- `400 validation_failed`: `personId` or `voice` is missing or invalid, the voice is not available\n  in this workspace, or the person has not replied in an iMessage thread (detail `recipient_must_reply`) or\n  texts on SMS (detail `sms_thread`). With a `touchId`, those two details are on `touchId`, and a\n  touch on another channel is `not_allowed`, one already sent or skipped `touch_ended` and one for another\n  person `wrong_person` (nothing is written, spoken or charged). When the touch is sent, skipped or deleted\n  while its note is made, the call returns `201` with the note `failed` (`failureReason`\n  `touch_ended`), nothing is charged and the note can't be sent. With a\n  `threadId`, they are on `threadId`: a value that is not a thread id is `invalid`, a thread on another\n  channel or a `threadId` sent with a `touchId` `not_allowed`, and a thread with another person\n  `wrong_person`.\n- `402 member_credit_limit_reached`: you reached your monthly credit limit in this workspace. The refusal is\n  in `error.refusal` and in the top-level `refusal`. Nothing is written, spoken or charged.\n- `403 permission_denied`: you do not have Inbox edit, or you are a member with the Client role.\n- `404 not_found`: no person has this id in the workspace, no touch you can see has the `touchId`, or no\n  iMessage thread in the workspace has the `threadId`.\n- `409 invalid_state` with detail `phone_opt_out`: the number the note would go to texted STOP, or the\n  person opted out of texts. With detail `do_not_call`: a provider the\n  workspace's own key asked flagged the person do not call. With detail `suppressed:<reason>` (such as `suppressed:blocklisted`): the\n  person is on the blocklist, on do-not-contact or unsubscribed, or (with a `touchId`) a domain of the touch's\n  account is on the blocklist, as the text's send reads it. The detail is on the field that named the thread\n  (`threadId`, `touchId`, else `personId`), and a reply to that number is refused the same way,\n  except that a member may still reply for `do_not_call` alone in a thread where the person has written. This\n  comes before every other refusal below, except `503 voice_notes_unavailable` while voice notes are off on\n  Kenso's side, for every caller and every `wordsMode`: Kenso does not text this person. Nothing is written,\n  spoken or charged.\n- `409 imessage_line_owner_left`: the owner of the line the note would go out on (the thread's line, or the\n  line the touch sends from) can't send from it anymore, as a reply or a touch's approval on that line is refused.\n  An admin can give the line a new owner in Delivery. Nothing is written, spoken or charged.\n- `409 imessage_line_gone`: that line can no longer send (it was released, failed or never activated), as a\n  reply on that thread is refused: nothing goes on the thread again. Nothing is written, spoken or charged.\n- `409 person_refused` on `personId`: the person said no and nothing since takes it back (a classed reply\n  that is no refusal, an accepted connection or a booked meeting), and an agent or an API key asked for the note\n  (any `wordsMode`) or Ken would write its words (`wordsMode` `ken_writes`, for anyone). A member can\n  still make one with their own `script`. Nothing is written, spoken or charged.\n- `503 service_unavailable` with detail `imessage_reply_unclassified` on `personId`: in the same\n  cases, the person wrote after their no and that message has no class yet. Retry in a few minutes. Nothing is\n  written, spoken or charged.\n- `503 voice_notes_unavailable`: voice notes are not available right now. Try again later.\n            \nRequires Inbox edit, and a member with the Client role cannot call it.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `imessage` feature on your workspace. Until it is on, calls answer 404.","operationId":"voice-notes.create","parameters":[{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The person the note is for and the voice that says it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImessageVoiceNoteRequest"}}}},"responses":{"201":{"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImessageVoiceNoteResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"402":{"description":"Payment Required","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["member_credit_limit_reached"]},"403":{"description":"Forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["forbidden","permission_denied"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"409":{"description":"Conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["imessage_line_gone","imessage_line_owner_left","invalid_state","person_refused"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]},"503":{"description":"Service Unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable","voice_notes_unavailable"]}},"x-ken-features":["imessage"],"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","summary":"Inbox edit"},"x-ken-rate-limit":{"limit":240,"windowSeconds":60,"per":"api_key"}}},"/v1/voice-notes/{voiceNoteId}":{"get":{"tags":["voice-notes"],"summary":"Get an iMessage voice note.","description":"Returns a voice note made with `POST /v1/voice-notes`: its `status`, the `touchId` or\n`threadId` it was made for, the member who asked for it (`createdByMemberId`), its `failureReason`,\nand when it was made and ready. Poll it while the status is\n`generating` (a touch's or thread's `imessage.voiceNoteInProgress` names the note being made), and stop at\nany other status: `ready` (play it with `audioUrl`), `sent`, `failed` or `expired`.\n            \nA note is made in about half a minute. One still generating about 85 seconds after `createdAt` was stopped part\nway and will not finish: it is returned as `failed` with `failureReason` `generation_unavailable`.\nMake a new note with `POST /v1/voice-notes`. Nothing was charged for the one that failed. A note whose touch\nwas sent, skipped or deleted while it was made is `failed` with `failureReason` `touch_ended`, and\nnothing was charged for it either.\n            \nErrors:\n            \n- `403 permission_denied`: you do not have Inbox edit, or you are a member with the Client role.\n- `404 not_found`: no note made with `POST /v1/voice-notes` in the workspace has this id (a note a workflow\n  made is not read here: play it with `GET /v1/voice-notes/{voiceNoteId}/imessage-audio`), or it is for a person\n  you cannot see.\n            \nRequires Inbox edit, and a member with the Client role cannot call it.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `imessage` feature on your workspace. Until it is on, calls answer 404.","operationId":"voice-notes.get","parameters":[{"name":"voiceNoteId","in":"path","description":"The voice note's id, from the create's `voiceNoteId` or `imessage.voiceNoteInProgress.id`.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImessageVoiceNoteResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"403":{"description":"Forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["permission_denied"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-features":["imessage"],"x-ken-permission":{"kind":"page","page":"inbox","access":"edit","summary":"Inbox edit"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/voice-notes/{voiceNoteId}/imessage-audio":{"get":{"tags":["voice-notes"],"summary":"Open the audio of a voice note on an iMessage text.","description":"The same audio as `GET /v1/voice-notes/{voiceNoteId}/audio`, for the notes iMessage texts carry: it works\nwhile iMessage is on for the workspace, even when LinkedIn voice notes are off. Redirects (302) to a link to the\naudio that works for 1 hour; fetch a new one rather than keeping it. Requires Inbox view: without it `403 permission_denied`. Another\nworkspace's note, or a note with no audio, is `404`; a note still being generated\n`409 voice_note_not_ready`, until about 85 seconds after it was asked for: one still generating then never\nfinishes and is `404`; audio deleted after the retention period (90 days) `410 gone`.\n`503 voice_notes_unavailable` while voice notes are not available on Kenso's side: try again later.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `imessage` feature on your workspace. Until it is on, calls answer 404.","operationId":"voice-notes.imessage-audio","parameters":[{"name":"voiceNoteId","in":"path","description":"The voice note's id, from its `voiceNote` object or a text's `imessage.voiceNoteId`.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"302":{"description":"Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"403":{"description":"Forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["permission_denied"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"409":{"description":"Conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["voice_note_not_ready"]},"410":{"description":"Gone","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["gone"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]},"503":{"description":"Service Unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}},"x-ken-error-codes":["voice_notes_unavailable"]}},"x-ken-features":["imessage"],"x-ken-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/voice-notes/{voiceNoteId}/audio":{"get":{"tags":["voice-notes"],"summary":"Get a voice note's audio","description":"Redirects with `302` to a link to the note's audio. The link works for 1 hour, so call this again each time\nyou play the note instead of keeping the link.\n            \nKenso deletes a note's audio 90 days after the note was sent, or after it was made when it was never sent.\n            \nErrors:\n            \n- `403 permission_denied`: the member cannot view the Inbox, so cannot hear its messages.\n- `404 not_found`: the note is not in this workspace, it has no audio, or the workspace feature its source needs\n  is off: `linkedin_voice_notes` for a LinkedIn step's note, a preview or an iMessage note made with\n  `POST /v1/voice-notes`, `whatsapp` for a WhatsApp message's note, and either for a workflow step's note.\n  Play the note an iMessage text carries with `GET /v1/voice-notes/{voiceNoteId}/imessage-audio`, the\n  `audioUrl` it carries.\n- `409 voice_note_not_ready`: Kenso is still making the audio. Try again shortly.\n- `410 gone`: Kenso deleted the audio after 90 days.\n- `503 voice_notes_unavailable`: voice notes are not available right now. Try again later.\n            \nRequires Inbox view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"voice-notes.audio","parameters":[{"name":"voiceNoteId","in":"path","description":"The voice note's id, from its `voiceNote` object.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"302":{"description":"Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"403":{"description":"Forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["permission_denied"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"409":{"description":"Conflict","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["voice_note_not_ready"]},"410":{"description":"Gone","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["gone"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]},"503":{"description":"Service Unavailable","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError"}}},"x-ken-error-codes":["voice_notes_unavailable"]}},"x-ken-permission":{"kind":"page","page":"inbox","access":"view","summary":"Inbox view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Enter: Bearer {your Kenso API key}. Create one in the Kenso app under Settings > Integrations > API Keys.","scheme":"bearer","bearerFormat":"Opaque API key"}},"headers":{"RateLimit-Limit":{"description":"The request limit of the rate limit this request is closest to reaching: your plan's limit for this kind of call, your API key's own limit, or the operation's own limit, whichever has the fewest requests left.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The requests left under that limit. `0` on a `429`.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"The seconds until that limit resets.","schema":{"type":"integer"}}},"schemas":{"ApiKeyError":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A sentence for people that says what went wrong. It can change, so do not parse it."}},"additionalProperties":false,"description":"The body the API key check in front of the operations answered until November 2026, instead of the error body (`Failure`): `{ \"error\": \"Invalid or revoked API key\" }` on a `401`, `{ \"error\": \"Rate limit exceeded\" }` on a `429` and `{ \"error\": \"Authentication is temporarily unavailable\" }` on a `503`. It has no `code`, so branch on the HTTP status."},"CreateImessageVoiceNoteRequest":{"type":"object","properties":{"personId":{"type":"integer","description":"The person the note is for: the `imessage.personId` of their iMessage thread. They must have replied in it.","format":"int64"},"voice":{"allOf":[{"$ref":"#/components/schemas/LinkedInVoiceNoteSettings"}],"description":"The voice and the words, as a voice note step takes them: `provider` (`deepgram` or `elevenlabs`),\n`voiceId`, `speed` (null or 0.5 to 1.5), `wordsMode` (`ken_writes` with `instructions`,\nor `script` with `script`), `model` (`haiku` or `sonnet`) and\n`matchLeadLanguage`."},"touchId":{"type":"integer","description":"Optional: the person's iMessage touch the note is for. The note is then judged on the thread that touch goes on (a\nreply's own thread), the touch shows it in `imessage.voiceNoteInProgress` while it is being made, and a second\ncall for the touch while it is being made returns that note instead of making and charging another. When it is\nready it goes on the touch as its `voiceNoteId` if the touch is still open, carries no images and has no voice\nnote, and nobody changed it meanwhile; if the touch is still open but one of those does not hold, the note is kept,\nand charged, for you to put on a touch. A touch\nalready sent or skipped is 400 with `touch_ended` on `touchId` (any other channel's touch:\n`not_allowed`); one sent, skipped or deleted while the note is made fails the note with `failureReason`\n`touch_ended`, uncharged.","format":"int64","nullable":true},"threadId":{"type":"string","description":"Optional: the person's iMessage thread the note is for, as its `thr_` id, such as the thread a member has open in\nthe inbox to reply with it (an agent or an API key sends a note on a touch, never as a reply).\nThe note is then judged on that thread, so a person who replied there can get one even when their latest thread is on\nanother number. The thread shows it in `imessage.voiceNoteInProgress` while it is being made, and a second call\nfor the thread while it is being made returns that note instead of making and charging another. Send `touchId`\nor `threadId`, not both.","nullable":true}},"additionalProperties":false,"description":"The person an iMessage voice note is for and the voice that says it.","example":{"personId":77310,"voice":{"provider":"elevenlabs","voiceId":"vc_7Qm2xB4kLpR9","wordsMode":"ken_writes","instructions":"Thank her for the reply and confirm Thursday at 2pm Central. Under 20 seconds.","model":"haiku","matchLeadLanguage":false},"threadId":"thr_aW1lc3NhZ2U6NTUxMjA0"}},"ErrorAccount":{"type":"object","properties":{"accountId":{"type":"integer","description":"The account's id.","format":"int64"},"name":{"type":"string","description":"The account's name."},"stakeholderId":{"type":"integer","description":"The person's stakeholder id on this account.","format":"int64"}},"additionalProperties":false,"description":"An account named in an error detail."},"ErrorBody":{"type":"object","properties":{"code":{"type":"string","description":"Stable error code, such as `validation_failed` or `not_found`. Branch on this value."},"message":{"type":"string","description":"A sentence for people that explains the error. It can change, so do not parse it."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"One entry per problem, naming the field or limit it is about. Omitted when there are none.","nullable":true},"requestId":{"type":"string","description":"The id of this request: the same value as the `X-Correlation-Id` response header. Quote it when you write\nto contact@ken.so."},"docUrl":{"type":"string","description":"The page on this code in the developer docs, which says what it means and how to fix it. The errors guide for a\ncode that has no page of its own.","readOnly":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"On a `402`, the plan rule or usage limit that refused the request and how to lift it. Omitted otherwise."},"impact":{"allOf":[{"$ref":"#/components/schemas/InvalidationImpact"}],"description":"On a `409` that refuses a change because it would clear stored AI output (a prompt edit, a restore or a\nreset), how much the change would clear. Omitted otherwise."},"surface":{"type":"string","description":"Set only by the voice ticket's `409` (code `voice_conversation_active`): the chat the person's other\nvoice conversation runs in, `support`, `ken` or `onboarding`. Omitted on every other error.","nullable":true}},"additionalProperties":false,"description":"What went wrong in a request."},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The request field, header or limit the problem is about, such as `name` or `Ken-Version`."},"code":{"type":"string","description":"Stable code for this problem, such as `required` or `invalid`."},"message":{"type":"string","description":"A sentence for people that explains this problem."},"count":{"type":"integer","description":"On `export_limit_exceeded`, how many rows match the export. Omitted otherwise.","format":"int32","nullable":true},"index":{"type":"integer","description":"The position of the refused item in the request's list. Omitted otherwise.","format":"int32","nullable":true},"limit":{"type":"integer","description":"On `export_limit_exceeded`, the row limit the export ran with. On a `quota_exceeded` detail whose\n`field` names a quota, that quota's limit. On a `rate_limited` detail from your workspace's rate\nlimits, the limit that was hit. Omitted otherwise.","format":"int32","nullable":true},"resetAt":{"type":"string","description":"On some `quota_exceeded` details, when the quota frees up, in UTC. It is the same instant as the top-level\n`quotaResetAt`. On a `rate_limited` detail from your workspace's rate limits, when that limit resets.\nOmitted otherwise.","format":"date-time","nullable":true},"retryAfterSeconds":{"type":"integer","description":"On those `quota_exceeded` details and on most `rate_limited` details, the seconds to wait. It is the\nsame value as the `Retry-After` header. Omitted otherwise.","format":"int32","nullable":true},"inboxId":{"type":"integer","description":"The inbox the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainId":{"type":"integer","description":"The domain the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The name of that domain, or the domain name the request gave. Omitted otherwise.","nullable":true},"accountId":{"type":"integer","description":"On `domain_taken`, `already_stakeholder` and `previously_removed`, the existing account to use\ninstead. Omitted otherwise.","format":"int64","nullable":true},"personId":{"type":"integer","description":"On `email_taken` and `linkedin_url_taken`, the existing person to use instead. Omitted otherwise.","format":"int64","nullable":true},"stakeholderId":{"type":"integer","description":"The account stakeholder the problem is about. Omitted otherwise.","format":"int64","nullable":true},"championId":{"type":"integer","description":"Not used. Always omitted.","format":"int64","nullable":true},"callTaskId":{"type":"integer","description":"On `call_task_exists`, the open call task that already holds the person's slot. Omitted otherwise.","format":"int64","nullable":true},"status":{"type":"string","description":"On `invalid_transition`, the current status. Omitted otherwise.","nullable":true},"allowed":{"type":"array","items":{"type":"string"},"description":"On `out_of_range`, the allowed values. On `invalid_transition`, the statuses the change is allowed\nfrom. Omitted otherwise.","nullable":true},"scope":{"type":"string","description":"On a `permission_denied` for an account owner change, the account scope the call needs (`all`). On\n`sending_paused`, what the pause covers: `inbox`, `domain` or `workspace`. Omitted otherwise.","nullable":true},"removedAt":{"type":"string","description":"On `previously_removed`, when a person removed the stakeholder, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"page":{"type":"string","description":"On `permission_denied`, the page the call needs, such as `campaigns`. Omitted otherwise.","nullable":true},"required":{"type":"string","description":"On `permission_denied`, the access `page` needs: `view` or `edit`. Omitted otherwise.","nullable":true},"feature":{"type":"string","description":"On `permission_denied`, the permission the call needs, such as `launch`. Omitted otherwise.","nullable":true},"runId":{"type":"integer","description":"On `committee_run_active` and `run_not_finding`, the committee run the problem is about. Omitted\notherwise.","format":"int64","nullable":true},"mergedIntoId":{"type":"integer","description":"On `person_merged`, the person the merged person now lives on. On `account_merged`, the account the\nmerged account now lives on. Omitted otherwise.","format":"int64","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAccount"},"description":"On `person_on_accounts`, the accounts that block the change. Omitted otherwise.","nullable":true},"stage":{"type":"string","description":"On `stage_in_use` and `system_stage`, the opportunity stage key the problem is about. Omitted otherwise.","nullable":true},"opportunityCount":{"type":"integer","description":"On `stage_in_use`, how many opportunities are in that stage. Omitted otherwise.","format":"int32","nullable":true},"rule":{"type":"string","description":"On `guardrail_violation`, the contact limit rule the change breaks. Omitted otherwise.","nullable":true},"nextAllowedAt":{"type":"string","description":"On `guardrail_violation`, the first `dueAt` that passes every contact limit, in UTC. On a refused\nsend, when to retry. Omitted otherwise, and when waiting does not clear it.","format":"date-time","nullable":true},"fix":{"type":"string","description":"On a refused send, what to do next, in plain words. Omitted otherwise.","nullable":true},"opensAt":{"type":"string","description":"On `outside_calling_hours`, when the person's calling window opens, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"On a knowledge file's `version_conflict`, the file's current version. Omitted otherwise.","format":"int32","nullable":true},"provider":{"type":"string","description":"On a CRM connection error (`provider_error`, `exchange_failed`, `already_connected`,\n`account_mismatch` or `provider_unavailable`), the CRM it is about. Omitted otherwise.","nullable":true},"sharedWithMaster":{"type":"boolean","description":"True on a `quota_exceeded` detail when the shared limit of the white-label master workspace was hit, so\n`limit` is the limit of the whole white-label account. Omitted otherwise. The master's id is never sent.","nullable":true},"stepId":{"type":"integer","description":"On `link_reputation_blocked`, the saved sequence step that holds the blocked link. Omitted otherwise, and\nfor a step the save would have created.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"On `link_reputation_blocked`, the `stepOrder` of that step. Omitted otherwise.","format":"int32","nullable":true},"url":{"type":"string","description":"On `link_reputation_blocked`, the blocked link as the step's copy writes it. Omitted otherwise.","nullable":true},"key":{"type":"string","description":"On `unfilled_template_key`, the template key the text still holds, such as `first_name` for\n`{first_name}`. Omitted otherwise.","nullable":true},"marker":{"type":"string","description":"On `unfilled_template_key`, that key as the text writes it, such as `{first_name}` or `[company]`.\nOmitted otherwise.","nullable":true},"retryAt":{"type":"string","description":"On a warm path Start's `guardrail_connector_monthly`, `guardrail_account_monthly`,\n`guardrail_connector_cooldown` and `guardrail_handoff_weekly`, when the limit frees up, in UTC. Omitted\notherwise.","format":"date-time","nullable":true},"workspaceId":{"type":"integer","description":"On `last_admin`, a workspace that needs a new admin before the account can be deleted. On\n`new_admin_not_found`, the workspace of the refused choice. Omitted otherwise.","format":"int64","nullable":true},"workspaceName":{"type":"string","description":"On `last_admin`, the name of that workspace. Omitted otherwise.","nullable":true},"class":{"type":"string","description":"On a `rate_limited` detail from your workspace's rate limits, the class of call that hit its limit:\n`read`, `write`, `bulk`, `heavy` or `sensitive`. Omitted otherwise.","nullable":true},"window":{"type":"string","description":"On that detail, the window whose limit was hit: `minute`, `day` or `bulkItemsDay`. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One problem in an error: the field or limit it is about, a stable `code` and a `message`. The other fields\nappear only with the codes their descriptions name."},"Failure":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on an error."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"What went wrong."},"quotaResetAt":{"type":"string","description":"When the quota that refused the request frees up, in UTC. Set on some quota refusals. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"The current revision of a workflow draft, on a draft save's `409 version_conflict`. Read the workflow\nagain, then send this value as `baseVersion`. Omitted otherwise.","format":"int32","nullable":true},"current":{"allOf":[{"$ref":"#/components/schemas/MeetingRepNotesCurrent"}],"description":"Your meeting notes and their version as stored now, on a meeting notes save's `409 version_conflict`.\nMerge your change, then save again with `baseVersion` set to `current.repNotesVersion`. Omitted\notherwise."},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"A copy of `error.refusal`, set on some billing refusals. Omitted otherwise."},"message":{"type":"string","description":"A copy of `error.message`, set together with `refusal`. Omitted otherwise.","nullable":true},"lookalikeSeeds":{"description":"How Kenso read each seed of a lookalike search, on its `422 no_usable_seeds`:\n`{resolved: [{input, companyId, personId, name, domain}], unresolved: [{input, reason}]}`. Use it to show\nwhy no seed was usable. Omitted otherwise."}},"additionalProperties":false,"description":"The body of every error, with a 4xx or 5xx status. Branch on `error.code`."},"ImessageVoiceNote":{"type":"object","properties":{"voiceNoteId":{"type":"integer","description":"The voice note's id.","format":"int64"},"status":{"type":"string","description":"`generating` while Kenso makes it, `ready` once its audio can be sent, `sent` once a text carried it,\n`failed` when it could not be made (see `failureReason`), or `expired`. Stop polling at any value but\n`generating`. One still generating about 85 seconds after `createdAt` reads `failed` with\n`generation_unavailable`: make a new note."},"touchId":{"type":"integer","description":"The iMessage touch it was made for (`touchId` at create). Omitted when none.","format":"int64","nullable":true},"threadId":{"type":"string","description":"The iMessage thread it was made for, as its `thr_` id (`threadId` at create, or the person's latest thread\nwhen the create sent neither `touchId` nor `threadId`). Omitted when none: a note made for a\n`touchId` names only its touch.","nullable":true},"failureReason":{"type":"string","description":"Why the note failed. Omitted unless status is `failed`.","nullable":true},"createdAt":{"type":"string","description":"When the note was asked for.","format":"date-time"},"createdByMemberId":{"type":"integer","description":"The member who asked for the note, as their member id (the id the workspace's member list gives). Omitted for a note\nan API key with no member made.","format":"int64","nullable":true},"readyAt":{"type":"string","description":"When its audio was ready. Omitted until then, and for a note that failed.","format":"date-time","nullable":true},"durationMs":{"type":"integer","description":"The audio's length in milliseconds. Omitted until known.","format":"int32","nullable":true},"language":{"type":"string","description":"The language of the script. Omitted when unknown.","nullable":true},"provider":{"type":"string","description":"The voice service that made the audio. Omitted when unknown.","nullable":true},"voiceId":{"type":"string","description":"The voice used for the audio. Omitted when unknown.","nullable":true},"scriptText":{"type":"string","description":"The words spoken. Omitted until generated.","nullable":true},"audioAvailable":{"type":"boolean","description":"True while Kenso keeps the audio."},"audioUrl":{"type":"string","description":"The API route that plays the audio (`GET /v1/voice-notes/{voiceNoteId}/imessage-audio`). Omitted when there is\nno audio.","nullable":true}},"additionalProperties":false,"description":"An iMessage voice note: its status, the touch or thread it was made for, who made it, and when it was made and ready.","example":{"voiceNoteId":4410,"status":"ready","touchId":51842,"threadId":"thr_aW1lc3NhZ2U6NTUxMjA0","createdAt":"2026-10-24T10:02:17Z","createdByMemberId":1093,"readyAt":"2026-10-24T10:02:31Z","durationMs":14200,"language":"en","provider":"elevenlabs","voiceId":"vc_7Qm2xB4kLpR9","scriptText":"Hi Amanda, it's Alex. Thanks for getting back to me. Thursday at 2pm Central works, I'll send the invite now. Talk soon.","audioAvailable":true,"audioUrl":"/v1/voice-notes/4410/imessage-audio"}},"ImessageVoiceNoteResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ImessageVoiceNote"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"InvalidationImpact":{"type":"object","properties":{"qualificationResponses":{"type":"integer","description":"Stored qualification answers the change would clear.","format":"int32"},"qualifiedFlags":{"type":"integer","description":"Contacts whose qualified result the change would clear.","format":"int32"},"segmentationReasoning":{"type":"integer","description":"Stored segmentation explanations the change would clear.","format":"int32"},"segmentationAssignmentsKept":{"type":"integer","description":"Contacts that keep their segment.","format":"int32"},"segmentationAssignmentsReset":{"type":"integer","description":"Contacts that go back to the default segment.","format":"int32"},"personalizationLines":{"type":"integer","description":"Personalized lines the change would clear.","format":"int32"},"personalizationLeads":{"type":"integer","description":"Contacts that would lose their personalized lines.","format":"int32"},"rewritingLines":{"type":"integer","description":"Rewritten lines the change would clear.","format":"int32"},"rewritingLeads":{"type":"integer","description":"Contacts that would lose their rewritten lines.","format":"int32"}},"additionalProperties":false,"description":"How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it\nkeeps or resets."},"LinkedInVoiceNoteSettings":{"required":["voiceId"],"type":"object","properties":{"provider":{"type":"string","description":"Who provides the voice: `deepgram` or `elevenlabs`. Variant A's value applies to every variant.","nullable":true},"voiceId":{"type":"string","description":"The voice's id at its provider, at most 200 characters. Required. Variant A's value applies to every variant."},"speed":{"type":"number","description":"How fast the voice speaks, from 0.50 to 1.50. Kenso applies it to Deepgram voices only. Null\nkeeps the provider's default. Variant A's value applies to every variant.","format":"double","nullable":true},"wordsMode":{"type":"string","description":"Where the words come from: `ken_writes` (Ken writes each contact's note from `instructions`) or\n`script` (Kenso speaks `script`).","nullable":true},"instructions":{"type":"string","description":"What Ken should say, at most 1,000 characters. Required when `wordsMode` is `ken_writes`, and must be\nempty when it is `script`.","nullable":true},"script":{"type":"string","description":"The words to speak, at most 900 characters, with contact `{tokens}` filled in for each contact. Required\nwhen `wordsMode` is `script`, and must be empty when it is `ken_writes`.","nullable":true},"model":{"type":"string","description":"The model Ken writes with: `haiku` or `sonnet`. Null or blank means `haiku`.","nullable":true},"matchLeadLanguage":{"type":"boolean","description":"When true, the note is spoken in the contact's outreach language when Kenso knows it."}},"additionalProperties":false,"description":"The voice settings of a LinkedIn voice note step: which voice speaks, and where the words come from. Every value\nthat names an option is a lowercase string."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"RateLimitedText":{"type":"string","description":"The gateway's plain-text body of a `429` over the operation's own limit, until November 2026: `Number of requests exceeded. Please try again later.`","example":"Number of requests exceeded. Please try again later."},"Refusal":{"type":"object","properties":{"code":{"type":"string","description":"Stable refusal code in upper case, such as `CAMPAIGN_LIMIT_REACHED` or `INSUFFICIENT_CREDITS`."},"metric":{"type":"string","description":"What the limit counts: `Campaigns`, `Leads`, `Emails`, `LinkedInSeats` or `AiCredits`,\n`jobs_export_rows` or `funding_export_rows` for an export allowance, `credit_pack_credits`,\n`credit_spend_usd_7d`, `domains` or `mailboxes` for a limit on a new paying workspace, or for a\nKenso Lifetime cap its key: `workspaces`, `inboxes`, `contacts`, `email_verifications_day`,\n`email_verifications_month`, `people_results_day`, `company_results_day`,\n`funding_results_day`, `job_post_results_day`, `website_visits_month` or\n`visitor_lookups_day`. Omitted when a plan rule, not a count, refused the request.","nullable":true},"used":{"type":"integer","description":"How much of the limit is used, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"limit":{"type":"integer","description":"The limit, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"remaining":{"type":"integer","description":"How much of the limit is left, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"planType":{"type":"string","description":"The workspace's plan as its snake plan id, for example `free`, `legacy_core` or `growth`."},"remedy":{"type":"string","description":"What lifts the refusal: `Upgrade`, `BuyAddOn`, `UpdatePaymentMethod` or `ContactSupport`.\n`None` means no action of yours lifts it."},"unlocksAt":{"type":"string","description":"When the limit lifts by itself, in UTC: for a limit on a new paying workspace once it has paid an invoice, and for\na Kenso Lifetime daily or monthly cap its reset (00:00 UTC, or the 1st of the month). Omitted on every other\nrefusal.","format":"date-time","nullable":true},"requiredMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits the action needed. 1,000 millicredits are one credit. Omitted on every\nother refusal.","format":"int64","nullable":true},"availableMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits available. On `FREE_CREDITS_NOT_ELIGIBLE`, only the credits that may\npay for inboxes and domains. Omitted on every other refusal.","format":"int64","nullable":true},"restrictedMillicredits":{"type":"integer","description":"On `FREE_CREDITS_NOT_ELIGIBLE`, the free and bonus millicredits in the balance that cannot pay for inboxes\nand domains. Omitted on every other refusal.","format":"int64","nullable":true},"feature":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the plan feature the plan does not include, in snake case (for example\n`website_visitor_id`). Omitted on every other refusal.","nullable":true},"requiredPlan":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the cheapest plan that includes `feature`, in snake case (for example\n`growth`). For a feature the self-serve trial locks (`browser_runs`), the trial's own plan,\nwhich paying for unlocks it. Omitted on every other refusal.","nullable":true},"requiredTier":{"type":"integer","description":"On a Kenso Lifetime refusal, the lowest tier that lifts it: the next tier with a higher cap, or the lowest tier\nthat includes `feature`. Omitted at the top tier, when no tier includes the feature, and on every other\nrefusal.","format":"int32","nullable":true},"upgradeUrl":{"type":"string","description":"On a Kenso Lifetime refusal that a higher tier lifts, the AppSumo page where the buyer upgrades their license.\nOmitted until Kenso has read that page from AppSumo, when no tier lifts the refusal, and on every other refusal.","nullable":true}},"additionalProperties":false,"description":"Why a plan rule or usage limit refused the request, and how to lift it."},"ServiceUnavailableError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The body of a `503`: the error body (`Failure`). When Kenso cannot check the API key, its code is `auth_unavailable`, with `Retry-After: 5`. Until November 2026 the API key check in front of the operations answered `{ \"error\": \"Authentication is temporarily unavailable\" }` (`ApiKeyError`) there instead, so handle both shapes. Retry after the `Retry-After` seconds."},"TooManyRequestsError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The JSON body of a `429`: the error body (`Failure`), with code `rate_limited` or `quota_exceeded`, over your workspace's rate limits, your API key's own limit, the operation's own limit or a usage quota. Until November 2026, over your API key's own limit the API key check answered `{ \"error\": \"Rate limit exceeded\" }` (`ApiKeyError`), and over the operation's own limit the gateway answered plain text (`RateLimitedText`): `Number of requests exceeded. Please try again later.` A client built against those answers keeps working: handle each shape. Wait the `Retry-After` seconds."},"UnauthorizedError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The body of a `401`: the error body (`Failure`), whose `code` says what is wrong with the credential. Until November 2026, when the API key was not valid (unknown, expired or revoked, or its member no longer active), the API key check in front of the operations answered `{ \"error\": \"Invalid or revoked API key\" }` (`ApiKeyError`), and a request with no API key got a `401` that has no body. A client built against those answers keeps working: handle both shapes and a `401` with no body."}}}}