> ## Documentation Index
> Fetch the complete documentation index at: https://developers.namuai-lab.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Every endpoint, field and response of the Namu API. Try each one from this page with your own key.

## Base URL

```text theme={null}
https://api.namuai-lab.com
```

Every endpoint lives under `/v1`. Requests and responses use HTTPS only.

## Endpoints

| Method | Endpoint | What it does | Key |
| - | - | - | :-: |
| `POST` | [`/v1/speech`](https://developers.namuai-lab.com/api-reference/speech/create-speech) | Text to speech | ✓ |
| `POST` | [`/v1/transcribe`](https://developers.namuai-lab.com/api-reference/transcription/create-transcription) | Speech to text | ✓ |
| `POST` | [`/v1/translate`](https://developers.namuai-lab.com/api-reference/translation/create-translation) | Hausa ⇄ French, text or speech | ✓ |
| `POST` | [`/v1/converse`](https://developers.namuai-lab.com/api-reference/voice-agent/converse) | One turn with the voice agent (research) | ✓ |
| `GET` | [`/v1/models`](https://developers.namuai-lab.com/api-reference/models-and-voices/list-models) | The models and their languages | |
| `GET` | [`/v1/voices`](https://developers.namuai-lab.com/api-reference/models-and-voices/list-voices) | The voices | |
| `GET` | [`/v1/usage`](https://developers.namuai-lab.com/api-reference/account/get-usage) | Your usage this month | ✓ |
| `GET` | [`/v1/health`](https://developers.namuai-lab.com/api-reference/account/health) | Whether the API is answering | |

## Conventions

* **Authentication:** `Authorization: Bearer namu_sk_...`. See [authentication](https://developers.namuai-lab.com/api-reference/authentication.md).
* **Bodies:** JSON for text (`/v1/speech`, text translation); multipart with a `file` field, or the raw audio as the body, for audio.
* **Errors:** always `{"error": {"type", "message", "request_id"}}`. See [errors](https://developers.namuai-lab.com/api-reference/errors.md).
* **Request ids:** every response has an `X-Request-Id` header.
* **No streaming yet:** every response arrives whole.
* **Versioning:** the version is in the path (`/v1`). Fields can be added to responses at any time; anything that would break an integration comes with notice in the [changelog](https://developers.namuai-lab.com/resources/changelog.md).

## OpenAPI

The reference is generated from an OpenAPI 3.1 description of the API. Download it to generate a client in your language or import it into Postman, Insomnia or Bruno:

> [card] [openapi.yaml](https://developers.namuai-lab.com/api-reference/openapi.yaml)
>
> The Namu API in OpenAPI 3.1.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.