Noirdoc documentation
From the first request to error handling: guides, reference and concepts for the Noirdoc gateway.
Noirdoc is a gateway with OpenAI- and Anthropic-compatible endpoints at https://api.noirdoc.de/v1. You authenticate with your organisation’s API key. You don’t need a provider account to use the gateway’s models.
The gateway picks a provider for each model and, on request, inspects inputs with Noirdoc Shield for secrets, personal data and prompt injections before the request reaches the model. Responses to model requests name the provider that answered them in the X-Noirdoc-Provider header.
Develop
Send requests and handle errors
Step-by-step guides with curl, Python and TypeScript, and a reference for every endpoint.
Concepts
Understand what the gateway does
How Noirdoc Shield protects inputs, the gateway selects providers and charges requests to your organisation’s credit.
Endpoints
The gateway accepts requests in the format of the OpenAI and the Anthropic API. What Noirdoc adds or changes at an endpoint is described on its reference page.
| Endpoint | Format | Reference |
|---|---|---|
POST /v1/chat/completions | OpenAI | Chat Completions |
POST /v1/responses | OpenAI | Responses |
POST /v1/messages | Anthropic | Messages |
POST /v1/embeddings | OpenAI | Embeddings |
POST /v1/rerank | Rerank format | Rerank |
POST /v1/audio/transcriptions, POST /v1/audio/speech | OpenAI | Audio |
POST /v1/images/generations | OpenAI | Images |
/v1/files | OpenAI, Anthropic | Files & Skills |
/v1/skills | Anthropic | Files & Skills |
POST /v1/shield/inspect, /v1/shield/policy | Noirdoc | Noirdoc Shield, Inspected fields |
GET /v1/models | OpenAI | Models & pricing |
GET /v1/prices | Noirdoc, without a key | Models & pricing |
/v1/tags | Noirdoc (Preview) | Request tags (Preview) |