# iroj API

> The iroj API translates text between English and Badini Kurdish (the Kurdish of Duhok and Zakho), reads text aloud in Badini voices, transcribes speech, and runs long jobs on documents and recordings. Base URL: https://api.iroj.ai/v1. Auth: `Authorization: Bearer iroj_live_...`. Languages: `en`, `bad`; scripts: `arab`, `latn`. Amounts are strings in euros with six decimals. Sorani is not offered.

## Start

- [Overview](https://docs.iroj.ai/): What the API does, the four services, and a first request.
- [Quickstart](https://docs.iroj.ai/quickstart): From no account to a first translation, a spoken sentence and a transcript, with the trial credit.
- [Authentication](https://docs.iroj.ai/authentication): API keys, their scopes and caps, rotation, and what to do with a leaked key.

## Services

- [Translate](https://docs.iroj.ai/translate): POST /v1/translate. Text between English and Badini, in Arabic or Latin script; every field, limit and error.
- [Speech](https://docs.iroj.ai/speech): POST /v1/speech. Text read aloud in a chosen voice, as audio bytes or as a signed link; the cost headers.
- [Voices](https://docs.iroj.ai/voices): GET /v1/voices. The voices a speech request may name, and the disclosure a cloned voice carries.
- [Transcription](https://docs.iroj.ai/transcription): POST /v1/transcriptions. A recording of up to ten minutes turned into text; formats, limits and cost.
- [Files and jobs](https://docs.iroj.ai/files-and-jobs): POST /v1/files and /v1/jobs. Documents translated, books read aloud and long recordings transcribed; estimates, polling, signed links, cancelling, retention, idempotency.
- [Webhooks](https://docs.iroj.ai/webhooks): The events job.completed, job.failed, job.cancelled and balance.low; the payload; verifying the Iroj-Signature header; retries.

## Using the API

- [Errors](https://docs.iroj.ai/errors): The shape of an error, the types, and every code with its status, meaning and what to do. Each code is an anchor: https://docs.iroj.ai/errors#rate_limited
- [Rate limits](https://docs.iroj.ai/rate-limits): Requests a minute and at once per organisation and service, the X-RateLimit headers, Retry-After, backing off, limits per plan.
- [Billing and usage](https://docs.iroj.ai/billing): The price list, units and minimums, the trial, pay as you go, plans, overage, caps, what is never charged, and how usage adds up.

## Background

- [Languages and scripts](https://docs.iroj.ai/languages): English and Badini, the Arabic and Latin scripts, what `script` does, and what is not offered.
- [Models](https://docs.iroj.ai/models): The models behind each service and their limits.
- [Data and privacy](https://docs.iroj.ai/data-and-privacy): What the request log keeps, how long files are kept, training use, and the acceptable-use rules.
- [Changelog](https://docs.iroj.ai/changelog): What each version of the API contains.

## Reference

- [API reference](https://docs.iroj.ai/reference): Every endpoint, parameter, body field, response, header and example, drawn from the OpenAPI file.
- [OpenAPI 3.1 file](https://docs.iroj.ai/openapi.yaml): The machine-readable contract of the whole API, with the error catalogue under `x-error-codes`.