Noirdoc-Dokumentation

Von der ersten Anfrage bis zur Fehlerbehandlung: Anleitungen, Referenz und Konzepte zum Noirdoc-Gateway.

Noirdoc ist ein Gateway mit OpenAI- und Anthropic-kompatiblen Endpunkten unter https://api.noirdoc.de/v1. Sie authentifizieren sich mit einem API-Schlüssel Ihrer Organisation. Für die Modelle des Gateways brauchen Sie kein Konto bei einem Anbieter.

Das Gateway wählt für jedes Modell einen Anbieter und maskiert auf Wunsch personenbezogene Daten, bevor die Anfrage das Modell erreicht. Antworten auf Modell-Anfragen nennen im Header X-Noirdoc-Provider den Anbieter, der sie beantwortet hat.

Entwickeln

Anfragen senden und Fehler behandeln

Schritt-für-Schritt-Anleitungen mit curl, Python und TypeScript und eine Referenz für jeden Endpunkt.

Konzepte

Verstehen, was das Gateway tut

Wie das Gateway maskiert, Anbieter auswählt und Anfragen mit dem Guthaben Ihrer Organisation verrechnet.

Endpunkte

Das Gateway nimmt Anfragen im Format der OpenAI- und der Anthropic-API an. Was Noirdoc an einem Endpunkt ergänzt oder ändert, steht auf der jeweiligen Referenzseite.

EndpunktFormatReferenz
POST /v1/chat/completionsOpenAIChat Completions
POST /v1/responsesOpenAIResponses
POST /v1/messagesAnthropicMessages
POST /v1/embeddingsOpenAIEmbeddings
POST /v1/audio/transcriptions, POST /v1/audio/speechOpenAIAudio
POST /v1/images/generationsOpenAIBilder
/v1/filesOpenAI, AnthropicDateien & Skills
/v1/skillsAnthropicDateien & Skills
GET /v1/modelsOpenAIModelle & Preise
GET /v1/pricesNoirdoc, ohne SchlüsselModelle & Preise
POST /v1/detect, POST /v1/pseudonymizeNoirdocErkennen & Pseudonymisieren