- Updating copy or instructions without a code deploy.
- Sharing a single prompt definition across multiple services.
- Letting non-engineers iterate on prompts through the UI without touching code.
Overview
Theorq.prompt parameter references a Prompt created in Orq.ai instead of hardcoding its messages in application code. The referenced prompt’s messages are prepended to the request messages before the model is called.
orq.prompt is supported on the Chat Completions endpoint POST https://my.orq.ai/v2/router/chat/completions. Only the latest version of a prompt can be referenced.
Quick Start
Configuration
How it works
- The router resolves the referenced Prompt at request time.
- The prompt’s messages are inserted at the start of the request
messages. - When the Prompt has a model configured, that model replaces the request
model. - When the prompt ID cannot be resolved, the request runs unchanged with the original
messagesandmodel. No error is returned.
Troubleshooting
Prompt content missing from responses A request with an unresolvable prompt reference does not fail; it runs without the prompt’s messages. Check the following:- Verify the prompt ID is correct.
- Check the Prompt exists in the workspace the API Key belongs to.
- Verify the Prompt was saved after the last edit.
model set in the request. Remove the model from the Prompt configuration to keep the request’s model.