Documentation / Quickstart

Make a transcription.

Create a job by sending a media file as multipart form data. A key is required for every API request.

Base URL
https://api.iian.site/v1

Create a job

Pass the local file path to curl. The API accepts supported audio and video formats; requests without a valid key return the authentication error shown in the authentication guide.

Request
curl https://api.iian.site/v1/transcriptions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@meeting.wav" \
  -F "language=en" \
  -F "webhook_url=https://your-app.example/hooks/iian"

Initial response

A successful request returns a job identifier and its initial state. The identifier is used to check progress and fetch the completed result.

Example JSON
{
  "id": "tr_7f31b8a2",
  "status": "queued",
  "created_at": "2026-10-09T16:20:00Z",
  "language": "en"
}

Wait for completion

Jobs run asynchronously. Poll GET /v1/transcriptions/{id} at a modest interval until the status is completed or failed. A completed job includes timestamped transcript segments. Avoid polling more frequently than once every few seconds.

Use a webhook

Optionally provide a webhook URL when creating the job. Iian sends a completion event when processing ends. Your endpoint should return a successful HTTP response promptly; if delivery fails, use the job endpoint to check the current result.