Notes

Get note transcript

Gets the complete plain-text transcript of a voice note or phone call owned by the authenticated user.

Returns text: null when no transcript is stored. An empty stored transcript is returned as text: "" with status: "available". Check status and retry_after before polling.

Transcripts are returned in full, without pagination.

Missing notes and notes owned by another user both return 404.

Requires the blinq:notes:read scope.

get/v1/notes/{id}/transcript

Request

  • Base URL
    https://api.blinq.me
  • Auth
    HTTP bearer

Path parameters

idstring required

The note ID.

Response

The requested note transcript.

status'available' | 'processing' | 'recording' | 'blocked' | 'failed' | 'unavailable' | 'not_applicable' required

available: text is ready; processing: retry later; recording: capture is ongoing; blocked: action is required in Blinq; failed: processing failed; unavailable: no transcript exists; not_applicable: a typed note.

retry_afterinteger nullable required

Suggested polling delay in seconds while processing; null for other states.

textstring nullable required

The complete plain-text transcript, or null when none is stored. An empty stored transcript is returned as "" with status available.

Changes

No recorded changes to this operation across all 1 revision of this API.