> For AI agents: the documentation index is at https://platform.detectif.ai/llms.txt. Every page is also available as Markdown by adding `.md` to its path.

# Noesis API Reference

Base URL, authentication, the live-call WebSocket, and every Noesis REST endpoint with its OpenAPI description.

Noesis has one WebSocket for live calls and a few REST endpoints. Every REST endpoint has its own page, generated from the OpenAPI description, with examples in cURL, Python and JavaScript.

## Base URL

```
https://api.noesis.detectif.ai
```

## Authentication

Send your API key as a bearer token. The key needs the Noesis permission (`noesis:detect` or `noesis:read`):

```bash
curl https://api.noesis.detectif.ai/v1/detect/usage \
  -H "Authorization: Bearer $DETECTIF_API_KEY"
```

See [Authentication](https://platform.detectif.ai/docs/noesis/authentication/).

## Live calls

| Endpoint | Description |
|---|---|
| `WS /v1/detect/stream` | One WebSocket per call: stream the callee's audio, receive the answers. OpenAPI does not describe WebSockets; see [Stream protocol](https://platform.detectif.ai/docs/noesis/stream-protocol/). |

## Endpoints

### Streams

| Method | Path | Page |
|---|---|---|
| `POST` | `/v1/detect/stream-tokens` | [Create a stream token](https://platform.detectif.ai/docs/noesis/api/create-stream-token/) |

### Recordings

| Method | Path | Page |
|---|---|---|
| `POST` | `/v1/detect/file` | [Analyse a call recording](https://platform.detectif.ai/docs/noesis/api/analyze-recording/) |

### Sessions

| Method | Path | Page |
|---|---|---|
| `GET` | `/v1/detect/sessions/{session_id}` | [Get a call session](https://platform.detectif.ai/docs/noesis/api/get-session/) |
| `GET` | `/v1/detect/sessions` | [List call sessions](https://platform.detectif.ai/docs/noesis/api/list-sessions/) |

### Usage

| Method | Path | Page |
|---|---|---|
| `GET` | `/v1/detect/usage` | [Get your Noesis usage](https://platform.detectif.ai/docs/noesis/api/get-usage/) |

### Health

| Method | Path | Page |
|---|---|---|
| `GET` | `/v1/health` | [Check service health](https://platform.detectif.ai/docs/noesis/api/get-health/) |
## OpenAPI and Postman

- [noesis-openapi.json](https://platform.detectif.ai/noesis-openapi.json)
- [noesis-openapi.yaml](https://platform.detectif.ai/noesis-openapi.yaml)
- [Download Postman collection](https://platform.detectif.ai/postman/detectif.postman_collection.json): the Noesis endpoints are in the **Noesis** folder, with their own `noesisBaseUrl` variable.
