> ## Documentation Index > Fetch the complete documentation index at: https://docs.orq.ai/llms.txt > Use this file to discover all available pages before exploring further. # List all prompts > Returns a list of your prompts. The prompts are returned sorted by creation date, with the most recent prompts appearing first **Related guide**: Prompts guide. See the [Prompts guide](/ai-studio/prompts/prompts) for a walkthrough with examples. ## OpenAPI ````yaml get /v2/prompts openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://my.orq.ai security: - ApiKey: [] tags: - name: Chunking description: Split text into smaller chunks for retrieval and generation workflows. - name: File Systems description: >- Create and manage persistent file systems that agents and MCP clients read from and write to. - name: Knowledge Bases description: Create and manage knowledge bases used by agents and retrieval workflows. - name: Memory Stores description: Create and manage memory stores, memories, and memory documents. - name: Evals description: Run an evaluator against a conversation and its result - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - name: Reporting description: >- GenAI reporting API over canonical analytics rollups. Accepts a metric name, time range, grain, group-by, and filters; returns a typed time series and optional totals. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - description: List models available through the AI Router. name: Models - name: Policies - name: Alerts description: >- Alerts evaluate a Reporting API metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: Annotation Queues description: Annotation queues collect spans for human review. - name: API keys description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. - name: Audit Logs description: Audit logs record workspace entity changes and access-relevant events. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - name: Hub description: Hub items are reusable templates available to a workspace. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the orq.ai model catalog: every model orq offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Projects description: Projects organize resources within a workspace - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Threads description: Threads group related trace invocations and their aggregate usage - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspaces description: >- A workspace is the tenant. Create is called from a user session during onboarding; Get, List, and Update are the public management surface. - name: Workspace Security description: >- Workspace-level domain verification and IP allowlist controls. These operations are restricted to workspace administrators. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings - name: Telemetry description: >- Unified query envelope for traces, metrics, and logs. One request shape, one filter dialect, and one response shape per source, validated by a per-source registry. - description: Beta. Run typed classification questions against a classify model. name: Classify - description: Search Gateway with managed credits or BYOK. name: Web Search externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/prompts: get: tags: - Prompts summary: List all prompts description: >- Returns a list of your prompts. The prompts are returned sorted by creation date, with the most recent prompts appearing first operationId: GetAllPrompts parameters: - schema: type: integer minimum: 1 maximum: 200 default: 10 description: >- A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10 required: false description: >- A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10 name: limit in: query - schema: type: string description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `starting_after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list. required: false description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `starting_after=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the next page of the list. name: starting_after in: query - schema: type: string description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `ending_before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list. required: false description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with `01JJ1HDHN79XAS7A01WB3HYSDB`, your subsequent call can include `ending_before=01JJ1HDHN79XAS7A01WB3HYSDB` in order to fetch the previous page of the list. name: ending_before in: query responses: '200': description: Prompts retrieved. content: application/json: schema: type: object properties: object: enum: - list type: string data: type: array items: type: object properties: _id: type: string type: type: string enum: - prompt owner: type: string domain_id: type: string format: uuid created: type: string updated: type: string created_by_id: type: - string - 'null' format: uuid updated_by_id: type: - string - 'null' format: uuid display_name: type: string maxLength: 128 description: >- The prompt’s name, meant to be displayable in the UI. description: type: - string - 'null' description: >- The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose prompt_config: type: object properties: stream: type: boolean model: type: - string - 'null' model_db_id: type: - string - 'null' model_type: type: - string - 'null' enum: - chat - completion - embedding - image - tts - stt - rerank - ocr - moderation - vision - null description: The modality of the model model_parameters: type: object properties: temperature: type: number description: >- Only supported on `chat` and `completion` models. maxTokens: type: number description: >- Only supported on `chat` and `completion` models. topK: type: number description: >- Only supported on `chat` and `completion` models. topP: type: number description: >- Only supported on `chat` and `completion` models. frequencyPenalty: type: number description: >- Only supported on `chat` and `completion` models. presencePenalty: type: number description: >- Only supported on `chat` and `completion` models. numImages: type: number description: Only supported on `image` models. seed: type: number description: >- Best effort deterministic seed for the model. Currently only OpenAI models support these format: type: string enum: - url - b64_json - text - json_object description: Only supported on `image` models. dimensions: type: string description: Only supported on `image` models. quality: type: string description: Only supported on `image` models. style: type: string description: Only supported on `image` models. responseFormat: anyOf: - type: object properties: type: type: string enum: - json_schema display_name: type: string json_schema: type: object properties: name: type: string description: type: - string - 'null' strict: type: boolean schema: type: object additionalProperties: {} required: - name - schema required: - type - json_schema - type: object properties: type: type: string enum: - json_object required: - type - type: object properties: type: type: string enum: - text required: - type - type: string enum: - mp3 - opus - aac - flac - wav - pcm - type: string enum: - url - base64_json - type: string enum: - json - text - srt - verbose_json - vtt - type: 'null' description: >- An object specifying the format that the model must output. Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON. Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length. cacheControl: type: - object - 'null' properties: type: description: >- Create a cache control breakpoint. Accepts only the value "ephemeral". enum: - ephemeral type: string ttl: type: string enum: - 5m - 1h default: 5m description: >- The time-to-live for the cache control breakpoint. This may be one of the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. Only supported by `Anthropic` Claude models. required: - type description: >- Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models. photoRealVersion: type: string enum: - v1 - v2 description: >- The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider encoding_format: type: string enum: - float - base64 description: The format to return the embeddings reasoningEffort: type: string enum: - none - disable - minimal - low - medium - high - xhigh - max description: >- Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. budgetTokens: type: number description: >- Gives the model enhanced reasoning capabilities for complex tasks. A value of 0 disables thinking. The minimum budget tokens for thinking are 1024. The Budget Tokens should never exceed the Max Tokens parameter. Only supported by `Anthropic` verbosity: description: Controls the verbosity of the model output. enum: - low - medium - high type: string thinkingLevel: type: string enum: - minimal - low - medium - high description: >- The level of thinking to use for the model. Only supported by `Google AI` description: >- Model Parameters: Not all parameters apply to every model provider: type: - string - 'null' enum: - openai - groq - cohere - azure - aws - google - google-ai - huggingface - togetherai - perplexity - anthropic - leonardoai - fal - nvidia - jina - elevenlabs - litellm - cerebras - openailike - bytedance - mistral - deepseek - moonshotai - zai - minimax - xai - alibaba - tensorix - scaleway - hcompany - inceptron - wafer - poolside - tencent - nebius - fireworks - baseten - reson8 - meta - greenpt - slack - orq - null integration_id: anyOf: - type: string - type: string format: ulid pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ readOnly: true description: The id of the resource - type: 'null' description: The ID of the integration to use version: type: string messages: type: array items: type: object properties: role: type: string enum: - system - developer - assistant - user - exception - tool - prompt - correction - expected_output description: The role of the prompt message content: anyOf: - type: string - type: array items: oneOf: - type: object properties: type: type: string enum: - text text: type: string required: - type - text description: Text content part of a prompt message - type: object properties: type: type: string enum: - image_url image_url: type: object properties: id: type: string format: ulid pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ readOnly: true description: The orq.ai id of the image url: type: string description: >- Either a URL of the image or the base64 encoded data URI. examples: - https://picsum.photos/id/1/200/300 - >- data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z detail: type: string description: >- Specifies the detail level of the image. Currently only supported with OpenAI models required: - url required: - type - image_url description: >- The image part of the prompt message. Only supported with vision models. - type: object properties: type: type: string enum: - file description: >- The type of the content part. Always `file`. file: type: object properties: file_data: type: string description: >- The file data as a data URI string in the format 'data:;base64,'. Example: 'data:image/png;base64,iVBORw0KGgoAAAANS...' uri: type: string description: >- URL to the file. Only supported by Anthropic Claude models for PDF files. mimeType: type: string description: >- MIME type of the file (e.g., application/pdf, image/png) filename: type: string description: >- The name of the file, used when passing the file to the model as a string. required: - type - file - type: 'null' description: >- The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Can be null for tool messages in certain scenarios. tool_calls: type: array items: type: object properties: id: type: string index: type: number type: type: string enum: - function function: type: object properties: name: type: string arguments: type: string description: JSON string arguments for the functions required: - name - arguments required: - type - function tool_call_id: type: - string - 'null' required: - role - content required: - messages deprecated: true description: >- [DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema. prompt: type: object properties: name: description: >- The name to display on the trace. If not specified, the default system name will be used. type: string audio: type: - object - 'null' properties: voice: type: string enum: - alloy - echo - fable - onyx - nova - shimmer description: >- The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer. format: type: string enum: - wav - mp3 - flac - opus - pcm16 description: >- Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16. required: - voice - format description: >- Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more. frequency_penalty: type: - number - 'null' description: >- Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. max_tokens: type: - integer - 'null' description: >- `[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models. max_completion_tokens: type: - integer - 'null' exclusiveMinimum: 0 description: >- An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens logprobs: type: - boolean - 'null' description: >- Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message. top_logprobs: type: - integer - 'null' minimum: 0 maximum: 20 description: >- An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used. 'n': type: - integer - 'null' minimum: 1 description: >- How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs. presence_penalty: type: - number - 'null' description: >- Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. response_format: oneOf: - type: object properties: type: type: string enum: - text required: - type title: Text description: >- Default response format. Used to generate text responses - type: object properties: type: type: string enum: - json_object required: - type title: JSON object description: >- JSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so. - type: object properties: type: type: string enum: - json_schema json_schema: type: object properties: description: description: >- A description of what the response format is for, used by the model to determine how to respond in the format. type: string name: type: string description: >- The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. schema: description: >- The schema for the response format, described as a JSON Schema object. strict: type: boolean default: false description: >- Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. required: - name required: - type - json_schema title: JSON schema description: >- JSON Schema response format. Used to generate structured JSON responses description: >- An object specifying the format that the model must output reasoning_effort: type: string enum: - none - minimal - low - medium - high - xhigh - max description: >- Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1. - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`. - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort. - `xhigh` is currently only supported for `gpt-5.1-codex-max`. Any of "none", "minimal", "low", "medium", "high", "xhigh", "max". verbosity: type: string description: >- Adjusts response verbosity. Lower levels yield shorter answers. seed: type: - number - 'null' description: >- If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. stop: anyOf: - type: string - type: array items: type: string maxItems: 4 - type: 'null' description: >- Up to 4 sequences where the API will stop generating further tokens. stream_options: type: - object - 'null' properties: include_usage: type: boolean description: >- If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value. description: >- Options for streaming response. Only set this when you set stream: true. thinking: oneOf: - $ref: >- #/components/schemas/ThinkingConfigDisabledSchema - $ref: >- #/components/schemas/ThinkingConfigEnabledSchema - $ref: >- #/components/schemas/ThinkingConfigAdaptiveSchema discriminator: propertyName: type mapping: disabled: >- #/components/schemas/ThinkingConfigDisabledSchema enabled: >- #/components/schemas/ThinkingConfigEnabledSchema adaptive: >- #/components/schemas/ThinkingConfigAdaptiveSchema temperature: type: - number - 'null' minimum: 0 maximum: 2 description: >- What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. top_p: type: - number - 'null' minimum: 0 maximum: 1 description: >- An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. top_k: type: - number - 'null' description: >- Limits the model to consider only the top k most likely tokens at each step. tool_choice: anyOf: - type: string enum: - none - auto - required - type: object properties: type: type: string enum: - function description: >- The type of the tool. Currently, only function is supported. function: type: object properties: name: type: string description: The name of the function to call. required: - name required: - function description: >- Controls which (if any) tool is called by the model. parallel_tool_calls: type: boolean description: >- Whether to enable parallel function calling during tool use. modalities: type: - array - 'null' items: type: string enum: - text - audio description: >- Output types that you would like the model to generate. Most models are capable of generating text, which is the default: ["text"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: ["text", "audio"]. guardrails: type: array items: type: object properties: id: anyOf: - type: string enum: - orq_pii_detection - orq_secret_detection - orq_sexual_moderation - orq_harmful_moderation description: The key of the guardrail. - type: string description: >- Unique key or identifier of the evaluator execute_on: type: string enum: - input - output description: >- Determines whether the guardrail runs on the input (user message) or output (model response). required: - id - execute_on description: A list of guardrails to apply to the request. plugins: type: array items: anyOf: - $ref: '#/components/schemas/PIIRedactionPlugin' - $ref: '#/components/schemas/ResponseHealingPlugin' - $ref: '#/components/schemas/TraceScrubbingPlugin' description: >- Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output. fallbacks: type: array items: type: object properties: model: type: string description: Fallback model identifier example: openai/gpt-5.4-mini required: - model description: >- Array of fallback models to use if primary model fails retry: type: object properties: count: type: number minimum: 1 maximum: 5 default: 3 description: Number of retry attempts (1-5) example: 3 on_codes: type: array items: type: number minimum: 100 maximum: 599 minItems: 1 description: HTTP status codes that trigger retry logic example: - 429 - 500 - 502 - 503 - 504 description: Retry configuration for the request cache: type: object properties: ttl: type: number minimum: 1 maximum: 259200 default: 1800 description: >- Time to live for cached responses in seconds. Maximum 259200 seconds (3 days). example: 3600 type: type: string enum: - exact_match required: - type description: Cache configuration for the request. load_balancer: oneOf: - type: object properties: type: type: string enum: - weight_based models: type: array items: type: object properties: model: type: string description: Model identifier for load balancing example: openai/gpt-5.6-sol weight: type: number minimum: 0.001 maximum: 1 default: 0.5 description: >- Weight assigned to this model for load balancing example: 0.7 required: - model required: - type - models description: Load balancer configuration for the request. example: type: weight_based models: - model: openai/gpt-4o weight: 0.7 - model: anthropic/claude-3-5-sonnet weight: 0.3 timeout: type: object properties: call_timeout: type: number minimum: 1 description: Timeout value in milliseconds example: 30000 required: - call_timeout description: >- Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". ttl: type: string enum: - 5m - 1h default: 5m description: >- The time-to-live for the cache control breakpoint. This may be one of the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. Only supported by `Anthropic` Claude models. required: - type description: >- Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models. prompt_cache_key: type: string description: >- Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching. messages: type: array items: oneOf: - type: object properties: role: type: string enum: - system description: >- The role of the messages author, in this case `system`. content: anyOf: - type: string description: The contents of the system message. - type: array items: $ref: >- #/components/schemas/TextContentPartSchema minItems: 1 description: >- An array of content parts with a defined type. For system messages, only type `text` is supported. description: The contents of the system message. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. required: - role - content title: System message description: >- Developer-provided instructions that the model should follow, regardless of messages sent by the user. - type: object properties: role: type: string enum: - user description: >- The role of the messages author, in this case `user`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. content: anyOf: - type: string description: The text contents of the message. - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema - $ref: >- #/components/schemas/ImageContentPartSchema - $ref: >- #/components/schemas/AudioContentPartSchema - type: object properties: type: type: string enum: - file description: >- The type of the content part. Always `file`. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". ttl: type: string enum: - 5m - 1h default: 5m description: >- The time-to-live for the cache control breakpoint. This may be one of the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. Only supported by `Anthropic` Claude models. required: - type file: $ref: >- #/components/schemas/FileContentPartSchema required: - type - file description: >- An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs. description: The contents of the user message. required: - role - content title: User message - type: object properties: reasoning_content: type: string description: >- Provider reasoning content that must be replayed with assistant tool calls when continuing a reasoning-model conversation. content: anyOf: - type: string description: The contents of the assistant message. - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema - $ref: '#/components/schemas/RefusalPartSchema' - $ref: '#/components/schemas/ReasoningPartSchema' - $ref: >- #/components/schemas/RedactedReasoningPartSchema discriminator: propertyName: type mapping: text: >- #/components/schemas/TextContentPartSchema refusal: '#/components/schemas/RefusalPartSchema' reasoning: '#/components/schemas/ReasoningPartSchema' redacted_reasoning: >- #/components/schemas/RedactedReasoningPartSchema description: >- An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. - type: 'null' description: >- The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. refusal: type: - string - 'null' description: The refusal message by the assistant. role: type: string enum: - assistant description: >- The role of the messages author, in this case `assistant`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. audio: type: - object - 'null' properties: id: type: string description: >- Unique identifier for a previous audio response from the model. required: - id description: >- Data about a previous audio response from the model. tool_calls: type: array items: type: object properties: id: type: string description: The ID of the tool call. type: type: string enum: - function description: >- The type of the tool. Currently, only `function` is supported. function: type: object properties: name: type: string description: The name of the function to call. arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. thought_signature: type: string description: >- Encrypted representation of the model internal reasoning state during function calling. Required by Gemini 3 models when continuing a conversation after a tool call. required: - id - type - function description: >- The tool calls generated by the model, such as function calls. required: - role title: Assistant message - type: object properties: role: type: string enum: - tool description: >- The role of the messages author, in this case tool. content: anyOf: - type: string - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema discriminator: propertyName: type mapping: text: >- #/components/schemas/TextContentPartSchema description: The contents of the tool message. tool_call_id: type: - string - 'null' description: >- Tool call that this message is responding to. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". ttl: type: string enum: - 5m - 1h default: 5m description: >- The time-to-live for the cache control breakpoint. This may be one of the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. Only supported by `Anthropic` Claude models. required: - type required: - role - content - tool_call_id title: Tool message description: >- Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content. model: type: - string - 'null' description: >- Model ID used to generate the response, like `openai/gpt-5.6-sol` or `anthropic/claude-sonnet-5`. For private models, use format: `{workspaceKey}@{provider}/{model}`. example: openai/gpt-5.6-sol version: type: string title: PromptField description: >- Prompt configuration with model and messages. Use this instead of prompt_config. metadata: type: object properties: use_cases: type: array items: type: string enum: - Agents simulations - Agents - API interaction - Autonomous Agents - Chatbots - Classification - Code understanding - Code writing - Conversation - Documents QA - Evaluation - Extraction - Multi-modal - Self-checking - Sentiment analysis - SQL - Summarization - Tagging - Translation (document) - Translation (sentences) description: >- A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose language: type: - string - 'null' enum: - Chinese - Dutch - English - French - German - Russian - Spanish - null description: >- The language that the prompt is written in. Use this field to categorize the prompt for your own purpose default: language: English required: - _id - type - owner - domain_id - created - updated - display_name - prompt title: Prompt description: >- A prompt entity with configuration, metadata, and versioning. has_more: type: boolean required: - object - data - has_more components: schemas: ThinkingConfigDisabledSchema: type: object properties: type: type: string enum: - disabled description: Disables the thinking mode capability required: - type title: Thinking config disabled description: Disables the thinking mode capability ThinkingConfigEnabledSchema: type: object properties: type: type: string enum: - enabled description: Enables or disables the thinking mode capability budget_tokens: type: number description: >- Determines how many tokens the model can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. thinking_level: type: string enum: - minimal - low - medium - high description: >- The level of reasoning the model should use. This setting is supported only by `gemini-3` models. If budget_tokens is specified and `thinking_level` is available, `budget_tokens` will be ignored. required: - type - budget_tokens title: Thinking config enabled description: Enables the thinking mode capability ThinkingConfigAdaptiveSchema: type: object properties: type: type: string enum: - adaptive description: >- Lets the model dynamically determine when and how much to use extended thinking based on the complexity of each request. Supported on Claude Opus 4.6 and Sonnet 4.6. required: - type title: Thinking config adaptive description: >- Enables adaptive thinking mode where the model dynamically determines thinking depth PIIRedactionPlugin: type: object properties: id: type: string enum: - pii_redaction description: PII redaction plugin. language: type: string description: >- Detector language. Accepts "auto" to detect the language per request; GET /v2/pii/capabilities lists the concrete languages and does not include "auto". Omitting the field falls back to en. regions: type: array items: type: string description: >- Region codes selecting whole regions of coverage (e.g. "nl", "gb"). Every entity type those regions cover is redacted, alongside the base catalog. ["all"] is exclusive, and leaving both this and entities empty also runs every region, so selecting nothing is the widest request rather than the narrowest. Combines with entities: the two selections are unioned, so entities adds types on top of the region coverage. entities: type: array items: type: string description: >- The entity types to redact. A named type is redacted even when it belongs to a region, so a region's types can be selected individually without naming the region. On its own this is a strict allowlist; alongside regions it adds to the region coverage. See GET /v2/pii/capabilities for valid types. entity_thresholds: type: object additionalProperties: type: number minimum: 0 maximum: 1 description: >- Per-entity confidence cutoff overrides in [0,1]. Tunes confidence only and never changes which types are redacted, so every key must also appear in entities. threshold: type: number minimum: 0 maximum: 1 description: >- Baseline confidence cutoff applied to every entity type without a per-entity override. on_failure: type: string enum: - block - passthrough description: Behaviour when detection fails. required: - id additionalProperties: false title: PII redaction plugin ResponseHealingPlugin: type: object properties: id: type: string enum: - response_healing description: Plugin discriminator. Must be `response_healing`. required: - id additionalProperties: false title: Response healing plugin TraceScrubbingPlugin: type: object properties: id: type: string enum: - trace_scrubbing description: Plugin discriminator. Must be `trace_scrubbing`. mask: type: array items: type: string enum: - all - system - input - output - metadata - variables minItems: 1 description: >- Trace surfaces to scrub. `all` includes system, input, output, metadata, and variables. required: - id - mask additionalProperties: false title: Trace scrubbing plugin TextContentPartSchema: type: object properties: type: type: string enum: - text description: The type of the content part. text: type: string description: The text content. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". ttl: type: string enum: - 5m - 1h default: 5m description: >- The time-to-live for the cache control breakpoint. This may be one of the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. Only supported by `Anthropic` Claude models. required: - type required: - type - text title: Text content part description: The type of the content part. ImageContentPartSchema: type: object properties: type: type: string enum: - image_url image_url: type: object properties: url: type: string description: Either a URL of the image or the base64 encoded image data. detail: type: string enum: - low - high - auto description: Specifies the detail level of the image. required: - url cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". ttl: type: string enum: - 5m - 1h default: 5m description: >- The time-to-live for the cache control breakpoint. This may be one of the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. Only supported by `Anthropic` Claude models. required: - type required: - type - image_url title: Image content part description: An image content part AudioContentPartSchema: type: object properties: type: type: string enum: - input_audio input_audio: type: object properties: data: type: string description: Base64 encoded audio data. format: type: string enum: - mp3 - wav description: >- The format of the encoded audio data. Currently supports `wav` and `mp3`. required: - data - format required: - type - input_audio title: Audio content part description: An audio content part FileContentPartSchema: type: object properties: file_data: type: string description: >- The file data as a data URI string in the format 'data:;base64,'. Example: 'data:image/png;base64,iVBORw0KGgoAAAANS...' uri: type: string description: >- URL to the file. Only supported by Anthropic Claude models for PDF files. mimeType: type: string description: MIME type of the file (e.g., application/pdf, image/png) filename: type: string description: >- The name of the file, used when passing the file to the model as a string. description: >- File data for the content part. Must contain either file_data or uri, but not both. RefusalPartSchema: type: object properties: type: type: string enum: - refusal description: The type of the content part. Always `refusal`. refusal: type: string description: The refusal message generated by the model. required: - type title: Refusal part description: A message part containing a refusal message. ReasoningPartSchema: type: object properties: type: type: string enum: - reasoning description: The type of the content part. Always `reasoning`. reasoning: type: string description: >- The reasoning or thought process behind the response. Used for chain-of-thought or extended thinking. signature: type: string description: >- Optional cryptographic signature to verify the authenticity and integrity of the reasoning content required: - type - reasoning - signature title: Reasoning Part description: A message part containing reasoning or chain-of-thought content RedactedReasoningPartSchema: type: object properties: type: type: string enum: - redacted_reasoning description: The type of the content part. Always `reasoning`. data: type: string description: >- The encrypted reasoning or thought process behind the response. Used for chain-of-thought or extended thinking. required: - type - data title: Reasoning Part description: A message part containing reasoning or chain-of-thought content securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.