HeyDonna REST API

The HeyDonna REST API lets you submit court reporter transcription jobs, track processing status, and manage templates — all without a browser.

Base URL: https://app.heydonna.chat

Generate an API key from your HeyDonna profile (Settings → API Keys) to get started. Contact support@heydonna.chat with any questions.

Quick Start

Generate an API key

Go to Settings → API Keys in your HeyDonna profile and click Generate Key. Copy the key — it is shown only once.

Your key looks like: hd_ext_a3f7c2... (55 characters total)

Submit a job

curl -X POST https://app.heydonna.chat/api/projects \
  -H "Authorization: Bearer hd_ext_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Smith v. Jones Deposition",
    "audioUrl": "https://your-s3-bucket.s3.amazonaws.com/audio.mp3?..."
  }'

Response:

{
  "projectId": "j57abc123def456",
  "transcriptId": "k89xyz789ghi012"
}

Poll for completion

curl https://app.heydonna.chat/api/projects/j57abc123def456/status \
  -H "Authorization: Bearer hd_ext_YOUR_KEY"

Poll every 10–30 seconds until status reaches a terminal state (ready, transcribed, finalized, or failed).

Endpoints

POST /api/projects GET /api/projects/:id/status GET /api/templates

Machine-Readable Spec

An OpenAPI 3.0.3 spec (opens in a new tab) is available in the repository for generating client SDKs or importing into tools like Postman, Insomnia, or Stoplight.

Profile Settings Authentication