Notre API integration
Request schema and route compatibility for NotrePublicOptionsV1.
On this page
Notre integrates additively on POST /v1/chat/completions only. Send Authorization: Bearer with a cd_live_ key. The optional notre object is stripped before the upstream provider. Embeddings, rerank, voice, images, and other routes ignore the field — Runtime does not compile those request shapes.
Request schema
type NotrePublicOptionsV1 = { mode?: "off" | "auto"; telemetry?: boolean;};Compatibility
- Omit notre — clients stay OpenAI-compatible; the gateway still decides apply vs strip via NOTRE_MODE
- mode auto — client intent to use Runtime when the deployment is not off
- stream: true — SSE protocol unchanged; no Notre chunk metadata in v1
- Tools and function calling — supported where the base chat route supports them
- Not embeddings, rerank, voice, or images