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
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Orq.ai Documentation","colors":{"primary":"#027f6b","light":"#00d2b5","dark":"#027f6b"},"logo":{"light":"https://mintcdn.com/orqai/OG_14djpK9Yasgfk/images/Orq_ai_Symbol_Dark.svg?fit=max\u0026auto=format\u0026n=OG_14djpK9Yasgfk\u0026q=85\u0026s=d01651850182afdbc6309808b688d470","dark":"https://mintcdn.com/orqai/BYq_L5I_ZDBWL_Pf/images/Orq_ai_Symbol_Light.svg?fit=max\u0026auto=format\u0026n=BYq_L5I_ZDBWL_Pf\u0026q=85\u0026s=3e372f93174202f20c31d2c045af92b9","href":"/ai-gateway/get-started/introduction"},"favicon":"https://mintcdn.com/orqai/rmwcfFw4PPljHRCz/favicon.svg?fit=max\u0026auto=format\u0026n=rmwcfFw4PPljHRCz\u0026q=85\u0026s=1827beca4e1fb46e074d8bda067f3fb1","api":{"openapi":"openapi.json","examples":{"languages":["curl","typescript","python"]}},"background":{"color":{"light":"#f7f6f5","dark":"#171717"}},"navbar":{"links":[],"primary":{"type":"button","label":"Get Started","href":"https://my.orq.ai/auth/signup"}},"footer":{"socials":{"github":"https://github.com/orq-ai","x":"https://x.com/orq_ai","linkedin":"https://www.linkedin.com/company/orqai","website":"https://orq.ai"}},"seo":{"metatags":{"author":"Orq.ai","og:type":"website","og:site_name":"Orq.ai Documentation","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@orq_ai","twitter:creator":"@orq_ai","viewport":"width=device-width, initial-scale=1.0","robots":"index, follow","language":"English"},"organization":{"id":"https://docs.orq.ai/#organization","name":"Orq.ai","legalName":"Orq.AI Holding B.V.","url":"https://orq.ai","logo":"https://docs.orq.ai/images/Orq_ai_Symbol_Dark.svg","sameAs":["https://github.com/orq-ai","https://x.com/orq_ai","https://www.linkedin.com/company/orqai/"]},"indexing":"all"},"fonts":{"heading":{"family":"ES Klarheit Kurrent Semibold","weight":600,"source":"https://framerusercontent.com/assets/HiovZWjG27S5NQhE8dyeECDMc.woff2","format":"woff2"},"body":{"family":"Inter","source":"https://cdn.jsdelivr.net/npm/@fontsource/inter@5.0.8/files/inter-latin-400-normal.woff2","format":"woff2"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"integrations":{"posthog":{"apiKey":"phc_MKGkZTCrnrBUKVqT0XxWbfDqCwik8EF2GIob0NhCU3C","apiHost":"https://eu.i.posthog.com"}},"contextual":{"options":["copy","download-spec","chatgpt","claude","view"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orqai","hasAudioNarration":false,"actualSubdomain":"orqai","customDomains":["docs.orq.ai"],"gitSource":{"type":"github","owner":"orq-ai","repo":"orquesta-web","deployBranch":"main","contentDirectory":"documentation/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4a1e5c4061e91428e02a9","collectionId":"e0d2b2d2-ce6b-4897-8927-c2806ac0e47b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4a1e5c4061e91428e02a9"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4a1e5c4061e91428e02a9","clientVersion":"0.0.4039","searchFilterCounts":[{"language":"default","tag":"API Reference","count":404},{"language":"default","tag":"Platform APIs","count":258},{"language":"default","tag":"Integrations","count":93},{"language":"default","tag":"Orq SDK","count":70},{"language":"default","tag":"AI Gateway","count":69},{"language":"default","tag":"Management APIs","count":68},{"language":"default","tag":"SDK Reference","count":67},{"language":"default","tag":"Cookbooks","count":34},{"language":"default","tag":"Model Providers","count":31},{"language":"default","tag":"Frameworks \u0026 SDKs","count":30}],"searchSettings":{"maxResults":15}},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@orq.ai","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".nav-anchor img{border-radius:50%}.ig-root{scroll-margin-top:6rem}.ig-search{width:100%;padding:10px 14px 10px 38px;border-radius:8px;border:1px solid rgba(0,0,0,.15);font-size:14px;outline:0;margin-bottom:20px;background:0 0;box-sizing:border-box;background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='none' viewBox='0 0 24 24'%3E%3Cpath stroke='%23999' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='m21 21-4.35-4.35M17 11A6 6 0 1 1 5 11a6 6 0 0 1 12 0Z'/%3E%3C/svg%3E\");background-repeat:no-repeat;background-position:12px center}.dark .ig-search{border-color:rgba(255,255,255,.15)}.ig-search:focus{border-color:#027f6b}.ig-tabs{display:flex;border-bottom:1px solid rgba(0,0,0,.1);margin-bottom:20px;gap:0}.dark .ig-tabs{border-bottom-color:rgba(255,255,255,.1)}.ig-tab{padding:8px 16px;background:0 0;border:0;border-bottom:2px solid transparent;margin-bottom:-1px;cursor:pointer;font-size:14px;font-weight:500;color:#888;white-space:nowrap}.ig-tab:hover{color:#027f6b}.dark .ig-tab:hover{color:#677f78}.ig-tab-active{border-bottom-color:#027f6b!important;color:#027f6b!important}.dark .ig-tab-active{border-bottom-color:#677f78!important;color:#677f78!important}.ig-grid{display:grid;grid-template-columns:repeat(4,1fr);gap:6px}@media (max-width:768px){.ig-grid{grid-template-columns:repeat(3,1fr)}}@media (max-width:480px){.ig-grid{grid-template-columns:repeat(2,1fr)}}.ig-card{display:flex;align-items:center;gap:8px;padding:10px 14px;border:1px solid rgba(0,0,0,.1);border-radius:6px;text-decoration:none!important;color:inherit!important;font-size:14px;font-weight:500;transition:background .12s,border-color .12s}.ig-card:hover{background:rgba(2,127,107,.05);border-color:rgba(2,127,107,.25)}.dark .ig-card{border-color:rgba(255,255,255,.1)}.dark .ig-card:hover{background:rgba(103,127,120,.1);border-color:rgba(103,127,120,.3)}.ig-card-icon{width:20px;height:20px;object-fit:contain;flex-shrink:0}.ig-tab-count{display:inline-flex;align-items:center;justify-content:center;margin-left:6px;padding:0 5px;min-width:18px;height:18px;border-radius:9px;font-size:11px;font-weight:600;background:rgba(0,0,0,.08);color:inherit}.dark .ig-tab-count{background:rgba(255,255,255,.12)}.ig-tab-active .ig-tab-count{background:rgba(2,127,107,.15)}.dark .ig-tab-active .ig-tab-count{background:rgba(103,127,120,.25)}.ig-empty{text-align:center;padding:48px 24px;color:#999;font-size:14px;grid-column:1/-1}kbd.key,kbd.key *{color:#fff!important}kbd.key{background:#242424;border-radius:5px;padding:2px 8px;font-size:.85em;display:inline-flex;align-items:center;gap:6px;border:1px solid #3a3a3a;font-family:inherit;white-space:nowrap}#sidebar-content .flex-1:has(>svg.flex-shrink-0){flex:none!important}#sidebar-content{width:16rem!important;min-width:16rem!important}@media (min-width:1024px){.lg\\:pl-56{padding-left:16rem!important}}.topbar-right-container nav[aria-label=Main] .navbar-link a,.topbar-right-container nav[aria-label=Main] .navbar-link a:hover{background-color:transparent!important}@media (min-width:1024px){.topbar-right-container nav[aria-label=Main] ul{gap:1rem!important}.topbar-right-container nav[aria-label=Main] .navbar-link a{padding-left:0!important;padding-right:0!important}#page-title{font-size:2rem!important;line-height:1.2!important}}.nav-tabs-item:has(a[href^='/reference']){display:none!important}#navbar .nav-tabs-item[href='/ai-studio/integrations/overview']{position:relative}#navbar .nav-tabs-item[href='/ai-studio/integrations/overview']::before{content:'';position:absolute;top:50%;left:-12px;transform:translateY(-50%);height:55%;width:1px;background:rgba(0,0,0,.15)}.dark #navbar .nav-tabs-item[href='/ai-studio/integrations/overview']::before{background:rgba(255,255,255,.15)}@media (min-width:1280px){#content-container{padding-left:3rem!important;padding-right:2rem!important}#content-side-layout{max-width:20rem!important}#content-area{width:calc(100% - 20rem)!important}}.md-export-list{display:none}"}],"page":{"pagePath":"reference/prompts/retrieve-a-prompt","slug":"/reference/prompts/retrieve-a-prompt","pageMetadata":{"openapi":"get /v2/prompts/{id}","title":"Retrieve a prompt","description":"Retrieves a prompt object","href":"/reference/prompts/retrieve-a-prompt"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves a prompt object\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Related guide`}),`: Prompts guide. See the `,_jsx(_components.a,{href:`/ai-studio/prompts/prompts`,children:`Prompts guide`}),` for a walkthrough with examples.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"openapi":"get /v2/prompts/{id}","title":"Retrieve a prompt","description":"Retrieves a prompt object","href":"/reference/prompts/retrieve-a-prompt"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/orqai/19ee3574279bbaa0/gtm.js","/_mintlify/custom/orqai/1f1a49b99957b631/commonroom-signals.js"],"openApiReferenceData":{"operation":{"tags":["Prompts"],"x-speakeasy-group":"prompts","x-speakeasy-name-override":"retrieve","x-cli-group":"prompts","x-cli-name":"retrieve","operationId":"GetOnePrompt","summary":"Retrieve a prompt","description":"Retrieves a prompt object","parameters":["37a851e6-0c82-44b1-86d7-1ec0c415d893"],"responses":{"200":"cefe602c-c1a9-4038-955c-267d385a3070","401":"c7531b10-220e-48ae-9b1a-6f116cda56c1","404":"abf6e733-95ad-447d-88aa-8cf1c8d82121"},"method":"get","type":"path","servers":["0d120802-8c97-467e-bd0f-d8f52b0765db"],"security":["56c5c662-cbe9-4db2-aca7-c481d5fb2d5b"],"path":"/v2/prompts/{id}","baseUrlOptions":["https://my.orq.ai"],"title":"Retrieve a prompt","codeSamples":[],"requestExampleLanguages":["bash","typescript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"37a851e6-0c82-44b1-86d7-1ec0c415d893":{"schema":{"type":"string","description":"Unique identifier of the prompt","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Unique identifier of the prompt","name":"id","in":"path"}},"responses":{"cefe602c-c1a9-4038-955c-267d385a3070":{"description":"Prompt retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","isRequired":true,"uniqueKey":"_id","typeLabel":"string"},"type":{"type":"string","enum":["prompt"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"owner":{"type":"string","isRequired":true,"uniqueKey":"owner","typeLabel":"string"},"domain_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"domain_id","typeLabel":"string\u003cuuid>"},"created":{"type":"string","isRequired":true,"uniqueKey":"created","typeLabel":"string"},"updated":{"type":"string","isRequired":true,"uniqueKey":"updated","typeLabel":"string"},"display_name":{"type":"string","maxLength":128,"description":"The prompt’s name, meant to be displayable in the UI.","isRequired":true,"uniqueKey":"display_name","typeLabel":"string"},"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","uniqueKey":"prompt.name","typeLabel":"string"},"audio":{"oneOf":[{"type":"object","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.","isRequired":true,"uniqueKey":"prompt.audio.oneOf.0.voice","typeLabel":"enum\u003cstring>"},"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.","isRequired":true,"uniqueKey":"prompt.audio.oneOf.0.format","typeLabel":"enum\u003cstring>"}},"required":["voice","format"],"description":"Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more.","uniqueKey":"prompt.audio.oneOf.0","typeLabel":"object"},{"type":"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.","uniqueKey":"prompt.audio.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.audio","typeLabel":"object | null"},"frequency_penalty":{"oneOf":[{"type":"number","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.","uniqueKey":"prompt.frequency_penalty.oneOf.0","typeLabel":"number"},{"type":"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.","uniqueKey":"prompt.frequency_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.frequency_penalty","typeLabel":"number | null"},"max_tokens":{"oneOf":[{"type":"integer","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. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.","uniqueKey":"prompt.max_tokens.oneOf.0","typeLabel":"integer"},{"type":"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. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.","uniqueKey":"prompt.max_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.max_tokens","typeLabel":"integer | null"},"max_completion_tokens":{"oneOf":[{"type":"integer","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","uniqueKey":"prompt.max_completion_tokens.oneOf.0","typeLabel":"integer"},{"type":"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","uniqueKey":"prompt.max_completion_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.max_completion_tokens","typeLabel":"integer | null"},"logprobs":{"oneOf":[{"type":"boolean","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.","uniqueKey":"prompt.logprobs.oneOf.0","typeLabel":"boolean"},{"type":"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.","uniqueKey":"prompt.logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.logprobs","typeLabel":"boolean | null"},"top_logprobs":{"oneOf":[{"type":"integer","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.","uniqueKey":"prompt.top_logprobs.oneOf.0","typeLabel":"integer"},{"type":"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.","uniqueKey":"prompt.top_logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.top_logprobs","typeLabel":"integer | null"},"n":{"oneOf":[{"type":"integer","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.","uniqueKey":"prompt.n.oneOf.0","typeLabel":"integer"},{"type":"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.","uniqueKey":"prompt.n.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.n","typeLabel":"integer | null"},"presence_penalty":{"oneOf":[{"type":"number","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.","uniqueKey":"prompt.presence_penalty.oneOf.0","typeLabel":"number"},{"type":"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.","uniqueKey":"prompt.presence_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.presence_penalty","typeLabel":"number | null"},"response_format":{"oneOf":[{"type":"object","title":"Text","description":"An object specifying the format that the model must output","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"prompt.response_format.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt.response_format.oneOf.0","typeLabel":"Text · object"},{"type":"object","title":"JSON object","description":"An object specifying the format that the model must output","required":["type"],"properties":{"type":{"type":"string","enum":["json_object"],"isRequired":true,"uniqueKey":"prompt.response_format.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt.response_format.oneOf.1","typeLabel":"JSON object · object"},{"type":"object","title":"JSON schema","description":"An object specifying the format that the model must output","required":["type","json_schema"],"properties":{"type":{"type":"string","enum":["json_schema"],"isRequired":true,"uniqueKey":"prompt.response_format.oneOf.2.type","typeLabel":"enum\u003cstring>"},"json_schema":{"type":"object","properties":{"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.","isRequired":true,"uniqueKey":"prompt.response_format.oneOf.2.json_schema.name","typeLabel":"string"},"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","uniqueKey":"prompt.response_format.oneOf.2.json_schema.description","typeLabel":"string"},"schema":{"description":"The schema for the response format, described as a JSON Schema object.","uniqueKey":"prompt.response_format.oneOf.2.json_schema.schema","typeLabel":"any"},"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.","uniqueKey":"prompt.response_format.oneOf.2.json_schema.strict","typeLabel":"boolean"}},"required":["name"],"isRequired":true,"uniqueKey":"prompt.response_format.oneOf.2.json_schema","typeLabel":"object"}},"uniqueKey":"prompt.response_format.oneOf.2","typeLabel":"JSON schema · object"}],"uniqueKey":"prompt.response_format","typeLabel":"Text · object | JSON object · object | JSON schema · object"},"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.\n\n- `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.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\", \"max\".","uniqueKey":"prompt.reasoning_effort","typeLabel":"enum\u003cstring>"},"verbosity":{"type":"string","description":"Adjusts response verbosity. Lower levels yield shorter answers.","uniqueKey":"prompt.verbosity","typeLabel":"string"},"seed":{"oneOf":[{"type":"number","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.","uniqueKey":"prompt.seed.oneOf.0","typeLabel":"number"},{"type":"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.","uniqueKey":"prompt.seed.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.seed","typeLabel":"number | null"},"stop":{"oneOf":[{"type":"string","description":"Up to 4 sequences where the API will stop generating further tokens.","uniqueKey":"prompt.stop.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"prompt.stop.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Up to 4 sequences where the API will stop generating further tokens.","maxItems":4,"uniqueKey":"prompt.stop.oneOf.1","typeLabel":"string[]"},{"type":"null","description":"Up to 4 sequences where the API will stop generating further tokens.","uniqueKey":"prompt.stop.oneOf.2","typeLabel":"null"}],"uniqueKey":"prompt.stop","typeLabel":"string | string[] | null"},"stream_options":{"oneOf":[{"type":"object","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.","uniqueKey":"prompt.stream_options.oneOf.0.include_usage","typeLabel":"boolean"}},"description":"Options for streaming response. Only set this when you set stream: true.","uniqueKey":"prompt.stream_options.oneOf.0","typeLabel":"object"},{"type":"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.","uniqueKey":"prompt.stream_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.stream_options","typeLabel":"object | null"},"thinking":{"oneOf":[{"type":"object","title":"Thinking config disabled","description":"Disables the thinking mode capability","required":["type"],"properties":{"type":{"type":"string","enum":["disabled"],"description":"Disables the thinking mode capability","isRequired":true,"uniqueKey":"prompt.thinking.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt.thinking.oneOf.0","typeLabel":"Thinking config disabled · object"},{"type":"object","title":"Thinking config enabled","description":"Enables the thinking mode capability","required":["type","budget_tokens"],"properties":{"type":{"type":"string","enum":["enabled"],"description":"Enables or disables the thinking mode capability","isRequired":true,"uniqueKey":"prompt.thinking.oneOf.1.type","typeLabel":"enum\u003cstring>"},"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`.","isRequired":true,"uniqueKey":"prompt.thinking.oneOf.1.budget_tokens","typeLabel":"number"},"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.","uniqueKey":"prompt.thinking.oneOf.1.thinking_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt.thinking.oneOf.1","typeLabel":"Thinking config enabled · object"},{"type":"object","title":"Thinking config adaptive","description":"Enables adaptive thinking mode where the model dynamically determines thinking depth","required":["type"],"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.","isRequired":true,"uniqueKey":"prompt.thinking.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt.thinking.oneOf.2","typeLabel":"Thinking config adaptive · object"}],"uniqueKey":"prompt.thinking","typeLabel":"Thinking config disabled · object | Thinking config enabled · object | Thinking config adaptive · object"},"temperature":{"oneOf":[{"type":"number","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.","uniqueKey":"prompt.temperature.oneOf.0","typeLabel":"number"},{"type":"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.","uniqueKey":"prompt.temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.temperature","typeLabel":"number | null"},"top_p":{"oneOf":[{"type":"number","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. ","uniqueKey":"prompt.top_p.oneOf.0","typeLabel":"number"},{"type":"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. ","uniqueKey":"prompt.top_p.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.top_p","typeLabel":"number | null"},"top_k":{"oneOf":[{"type":"number","description":"Limits the model to consider only the top k most likely tokens at each step.","uniqueKey":"prompt.top_k.oneOf.0","typeLabel":"number"},{"type":"null","description":"Limits the model to consider only the top k most likely tokens at each step.","uniqueKey":"prompt.top_k.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.top_k","typeLabel":"number | null"},"tool_choice":{"oneOf":[{"type":"string","description":"Controls which (if any) tool is called by the model.","enum":["none","auto","required"],"uniqueKey":"prompt.tool_choice.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Controls which (if any) tool is called by the model.","required":["function"],"properties":{"function":{"type":"object","properties":{"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"prompt.tool_choice.oneOf.1.function.name","typeLabel":"string"}},"required":["name"],"isRequired":true,"uniqueKey":"prompt.tool_choice.oneOf.1.function","typeLabel":"object"},"type":{"type":"string","enum":["function"],"description":"The type of the tool. Currently, only function is supported.","uniqueKey":"prompt.tool_choice.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt.tool_choice.oneOf.1","typeLabel":"object"}],"uniqueKey":"prompt.tool_choice","typeLabel":"enum\u003cstring> | object"},"parallel_tool_calls":{"type":"boolean","description":"Whether to enable parallel function calling during tool use.","uniqueKey":"prompt.parallel_tool_calls","typeLabel":"boolean"},"modalities":{"oneOf":[{"type":"array","items":{"type":"string","enum":["text","audio"],"uniqueKey":"prompt.modalities.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"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\"].","uniqueKey":"prompt.modalities.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"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\"].","uniqueKey":"prompt.modalities.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.modalities","typeLabel":"enum\u003cstring>[] | null"},"guardrails":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"The key of the guardrail.","enum":["orq_pii_detection","orq_secret_detection","orq_sexual_moderation","orq_harmful_moderation"],"isRequired":true,"uniqueKey":"prompt.guardrails.items.[INDEX].id.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Unique key or identifier of the evaluator","isRequired":true,"uniqueKey":"prompt.guardrails.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"prompt.guardrails.items.[INDEX].id","typeLabel":"enum\u003cstring> | string"},"execute_on":{"type":"string","enum":["input","output"],"description":"Determines whether the guardrail runs on the input (user message) or output (model response).","isRequired":true,"uniqueKey":"prompt.guardrails.items.[INDEX].execute_on","typeLabel":"enum\u003cstring>"}},"required":["id","execute_on"],"uniqueKey":"prompt.guardrails.items.[INDEX]","typeLabel":"object"},"description":"A list of guardrails to apply to the request.","uniqueKey":"prompt.guardrails","typeLabel":"object[]"},"plugins":{"type":"array","items":{"oneOf":[{"type":"object","title":"PII redaction plugin","required":["id"],"properties":{"id":{"type":"string","enum":["pii_redaction"],"description":"PII redaction plugin.","isRequired":true,"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.id","typeLabel":"enum\u003cstring>"},"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 defaults to \"auto\".","uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.language","typeLabel":"string"},"regions":{"type":"array","items":{"type":"string","uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.regions.items.[INDEX]","typeLabel":"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.","uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.regions","typeLabel":"string[]"},"entities":{"type":"array","items":{"type":"string","uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.entities.items.[INDEX]","typeLabel":"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.","uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.entities","typeLabel":"string[]"},"entity_thresholds":{"type":"object","additionalProperties":{"type":"number","minimum":0,"maximum":1,"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.entity_thresholds.additionalProperties","typeLabel":"number"},"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.","uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.entity_thresholds","typeLabel":"object"},"threshold":{"type":"number","minimum":0,"maximum":1,"description":"Baseline confidence cutoff applied to every entity type without a per-entity override.","uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.threshold","typeLabel":"number"},"on_failure":{"type":"string","enum":["block","passthrough"],"description":"Behaviour when detection fails.","uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0.on_failure","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.0","typeLabel":"PII redaction plugin · object"},{"type":"object","title":"Response healing plugin","required":["id"],"properties":{"id":{"type":"string","enum":["response_healing"],"description":"Plugin discriminator. Must be `response_healing`.","isRequired":true,"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.1.id","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.1","typeLabel":"Response healing plugin · object"},{"type":"object","title":"Trace scrubbing plugin","required":["id","mask"],"properties":{"id":{"type":"string","enum":["trace_scrubbing"],"description":"Plugin discriminator. Must be `trace_scrubbing`.","isRequired":true,"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.2.id","typeLabel":"enum\u003cstring>"},"mask":{"type":"array","items":{"type":"string","enum":["all","system","input","output","metadata","variables"],"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.2.mask.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Trace surfaces to scrub. `all` includes system, input, output, metadata, and variables.","isRequired":true,"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.2.mask","typeLabel":"enum\u003cstring>[]"}},"additionalProperties":false,"uniqueKey":"prompt.plugins.items.[INDEX].oneOf.2","typeLabel":"Trace scrubbing plugin · object"}],"uniqueKey":"prompt.plugins.items.[INDEX]","typeLabel":"PII redaction plugin · object | Response healing plugin · object | Trace scrubbing plugin · object"},"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.","uniqueKey":"prompt.plugins","typeLabel":"(PII redaction plugin · object | Response healing plugin · object | Trace scrubbing plugin · object)[]"},"fallbacks":{"type":"array","items":{"type":"object","properties":{"model":{"type":"string","description":"Fallback model identifier","example":"openai/gpt-5.4-mini","isRequired":true,"uniqueKey":"prompt.fallbacks.items.[INDEX].model","typeLabel":"string"}},"required":["model"],"uniqueKey":"prompt.fallbacks.items.[INDEX]","typeLabel":"object"},"description":"Array of fallback models to use if primary model fails","uniqueKey":"prompt.fallbacks","typeLabel":"object[]"},"retry":{"type":"object","properties":{"count":{"type":"number","minimum":1,"maximum":5,"default":3,"description":"Number of retry attempts (1-5)","example":3,"uniqueKey":"prompt.retry.count","typeLabel":"number"},"on_codes":{"type":"array","items":{"type":"number","minimum":100,"maximum":599,"uniqueKey":"prompt.retry.on_codes.items.[INDEX]","typeLabel":"number"},"minItems":1,"description":"HTTP status codes that trigger retry logic","example":[429,500,502,503,504],"uniqueKey":"prompt.retry.on_codes","typeLabel":"number[]"}},"description":"Retry configuration for the request","uniqueKey":"prompt.retry","typeLabel":"object"},"cache":{"type":"object","properties":{"type":{"type":"string","enum":["exact_match"],"isRequired":true,"uniqueKey":"prompt.cache.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"number","minimum":1,"maximum":259200,"default":3600,"description":"Time to live for cached responses in seconds. Maximum 259200 seconds (3 days).","example":3600,"uniqueKey":"prompt.cache.ttl","typeLabel":"number"}},"required":["type"],"description":"Cache configuration for the request.","uniqueKey":"prompt.cache","typeLabel":"object"},"load_balancer":{"type":"object","description":"Load balancer configuration for the request.","required":["type","models"],"example":{"type":"weight_based","models":[{"model":"openai/gpt-4o","weight":0.7},{"model":"anthropic/claude-3-5-sonnet","weight":0.3}]},"properties":{"type":{"type":"string","enum":["weight_based"],"isRequired":true,"uniqueKey":"prompt.load_balancer.type","typeLabel":"enum\u003cstring>"},"models":{"type":"array","items":{"type":"object","properties":{"model":{"type":"string","description":"Model identifier for load balancing","example":"openai/gpt-5.6-sol","isRequired":true,"uniqueKey":"prompt.load_balancer.models.items.[INDEX].model","typeLabel":"string"},"weight":{"type":"number","minimum":0.001,"maximum":1,"default":0.5,"description":"Weight assigned to this model for load balancing","example":0.7,"uniqueKey":"prompt.load_balancer.models.items.[INDEX].weight","typeLabel":"number"}},"required":["model"],"uniqueKey":"prompt.load_balancer.models.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"prompt.load_balancer.models","typeLabel":"object[]"}},"uniqueKey":"prompt.load_balancer","typeLabel":"object"},"timeout":{"type":"object","properties":{"call_timeout":{"type":"number","minimum":1,"description":"Timeout value in milliseconds","example":30000,"isRequired":true,"uniqueKey":"prompt.timeout.call_timeout","typeLabel":"number"}},"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.","uniqueKey":"prompt.timeout","typeLabel":"object"},"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\".","isRequired":true,"uniqueKey":"prompt.cache_control.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"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.","uniqueKey":"prompt.cache_control","typeLabel":"object"},"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.","uniqueKey":"prompt.prompt_cache_key","typeLabel":"string"},"messages":{"type":"array","items":{"oneOf":[{"type":"object","title":"System message","description":"Developer-provided instructions that the model should follow, regardless of messages sent by the user.","required":["role","content"],"properties":{"role":{"type":"string","enum":["system"],"description":"The role of the messages author, in this case `system`.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The contents of the system message.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"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\".","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].cache_control.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].cache_control.ttl","typeLabel":"enum\u003cstring>"}},"required":["type"],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].cache_control","typeLabel":"object"}},"required":["type","text"],"title":"Text content part","description":"The type of the content part.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object"},"description":"The contents of the system message.","minItems":1,"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content.oneOf.1","typeLabel":"Text content part · object[]"}],"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.content","typeLabel":"string | Text content part · object[]"},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.0.name","typeLabel":"string"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.0","typeLabel":"System message · object"},{"type":"object","title":"User message","required":["role","content"],"properties":{"role":{"type":"string","enum":["user"],"description":"The role of the messages author, in this case `user`.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The contents of the user message.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","title":"Text content part","description":"The type of the content part.","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"},"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\".","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.0.cache_control.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.0.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"required":["type"],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.0.cache_control","typeLabel":"object"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"Text content part · object"},{"type":"object","title":"Image content part","description":"An image content part","required":["type","image_url"],"properties":{"type":{"type":"string","enum":["image_url"],"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"image_url":{"type":"object","properties":{"url":{"type":"string","description":"Either a URL of the image or the base64 encoded image data.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.1.image_url.url","typeLabel":"string"},"detail":{"type":"string","enum":["low","high","auto"],"description":"Specifies the detail level of the image.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.1.image_url.detail","typeLabel":"enum\u003cstring>"}},"required":["url"],"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.1.image_url","typeLabel":"object"},"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\".","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.1.cache_control.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.1.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"required":["type"],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.1.cache_control","typeLabel":"object"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"Image content part · object"},{"type":"object","title":"Audio content part","description":"An audio content part","required":["type","input_audio"],"properties":{"type":{"type":"string","enum":["input_audio"],"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"input_audio":{"type":"object","properties":{"data":{"type":"string","description":"Base64 encoded audio data.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.2.input_audio.data","typeLabel":"string"},"format":{"type":"string","enum":["mp3","wav"],"description":"The format of the encoded audio data. Currently supports `wav` and `mp3`.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.2.input_audio.format","typeLabel":"enum\u003cstring>"}},"required":["data","format"],"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.2.input_audio","typeLabel":"object"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"Audio content part · object"},{"type":"object","required":["type","file"],"properties":{"type":{"type":"string","enum":["file"],"description":"The type of the content part. Always `file`.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"file":{"type":"object","properties":{"file_data":{"type":"string","description":"The file data as a data URI string in the format `data:\u003cmime-type>;base64,\u003cbase64-encoded-data>`. Example: `data:image/png;base64,iVBORw0KGgoAAAANS...`","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.file.file_data","typeLabel":"string"},"uri":{"type":"string","description":"URL of the file. Supported for PDFs on Anthropic Claude models and for `https://` and Google Cloud Storage `gs://` URIs on Vertex AI Gemini models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.file.uri","typeLabel":"string"},"mimeType":{"type":"string","description":"MIME type of the file (e.g., application/pdf, image/png). Inferred from `filename` or the URI extension when omitted.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.file.mimeType","typeLabel":"string"},"file_id":{"type":"string","description":"A provider file reference: a Google Cloud Storage `gs://` URI for Vertex AI Gemini models, or an OpenAI file ID (`file-...`) for OpenAI models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.file.file_id","typeLabel":"string"},"filename":{"type":"string","description":"The name of the file, used when passing the file to the model as a string.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.file.filename","typeLabel":"string"}},"description":"File data for the content part. Must contain exactly one of file_data, file_id or uri.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.file","typeLabel":"object"},"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\".","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.cache_control.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"required":["type"],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3.cache_control","typeLabel":"object"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object | Image content part · object | Audio content part · object | object"},"description":"The contents of the user message.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content.oneOf.1","typeLabel":"(Text content part · object | Image content part · object | Audio content part · object | object)[]"}],"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.content","typeLabel":"string | (Text content part · object | Image content part · object | Audio content part · object | object)[]"},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.1.name","typeLabel":"string"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.1","typeLabel":"User message · object"},{"type":"object","title":"Assistant message","required":["role"],"properties":{"role":{"type":"string","enum":["assistant"],"description":"The role of the messages author, in this case `assistant`.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.role","typeLabel":"enum\u003cstring>"},"reasoning_content":{"type":"string","description":"Provider reasoning content that must be replayed with assistant tool calls when continuing a reasoning-model conversation.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.reasoning_content","typeLabel":"string"},"content":{"oneOf":[{"type":"string","description":"The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","title":"Text content part","description":"The type of the content part.","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"},"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\".","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0.cache_control.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"required":["type"],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0.cache_control","typeLabel":"object"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"Text content part · object"},{"type":"object","title":"Refusal part","description":"A message part containing a refusal message.","required":["type"],"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the content part. Always `refusal`.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"refusal":{"type":"string","description":"The refusal message generated by the model.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.refusal","typeLabel":"string"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"Refusal part · object"},{"type":"object","title":"Reasoning Part","description":"A message part containing reasoning or chain-of-thought content","required":["type","reasoning","signature"],"properties":{"type":{"type":"string","enum":["reasoning"],"description":"The type of the content part. Always `reasoning`.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"reasoning":{"type":"string","description":"The reasoning or thought process behind the response. Used for chain-of-thought or extended thinking.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.reasoning","typeLabel":"string"},"signature":{"type":"string","description":"Optional cryptographic signature to verify the authenticity and integrity of the reasoning content","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.signature","typeLabel":"string"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"Reasoning Part · object"},{"type":"object","title":"Reasoning Part","description":"A message part containing reasoning or chain-of-thought content","required":["type","data"],"properties":{"type":{"type":"string","enum":["redacted_reasoning"],"description":"The type of the content part. Always `reasoning`.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"data":{"type":"string","description":"The encrypted reasoning or thought process behind the response. Used for chain-of-thought or extended thinking.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3.data","typeLabel":"string"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.3","typeLabel":"Reasoning Part · object"}],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object · Refusal part · object · Reasoning Part · object · Reasoning Part · object"},"description":"The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.1","typeLabel":"Text content part · object · Refusal part · object · Reasoning Part · object · Reasoning Part · object[]"},{"type":"null","description":"The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content.oneOf.2","typeLabel":"null"}],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.content","typeLabel":"string | Text content part · object · Refusal part · object · Reasoning Part · object · Reasoning Part · object[] | null"},"refusal":{"oneOf":[{"type":"string","description":"The refusal message by the assistant.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.refusal.oneOf.0","typeLabel":"string"},{"type":"null","description":"The refusal message by the assistant.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.refusal.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.refusal","typeLabel":"string | null"},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.name","typeLabel":"string"},"audio":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for a previous audio response from the model.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.audio.oneOf.0.id","typeLabel":"string"}},"required":["id"],"description":"Data about a previous audio response from the model. ","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.audio.oneOf.0","typeLabel":"object"},{"type":"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. ","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.audio.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.audio","typeLabel":"object | null"},"tool_calls":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the tool call.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.tool_calls.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["function"],"description":"The type of the tool. Currently, only `function` is supported.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.tool_calls.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","properties":{"name":{"type":"string","description":"The name of the function to call.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.tool_calls.items.[INDEX].function.name","typeLabel":"string"},"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.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.tool_calls.items.[INDEX].function.arguments","typeLabel":"string"}},"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.tool_calls.items.[INDEX].function","typeLabel":"object"},"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.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.tool_calls.items.[INDEX].thought_signature","typeLabel":"string"}},"required":["id","type","function"],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.tool_calls.items.[INDEX]","typeLabel":"object"},"description":"The tool calls generated by the model, such as function calls.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.2.tool_calls","typeLabel":"object[]"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.2","typeLabel":"Assistant message · object"},{"type":"object","title":"Tool message","required":["role","content","tool_call_id"],"properties":{"role":{"type":"string","enum":["tool"],"description":"The role of the messages author, in this case tool.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The contents of the tool message.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","title":"Text content part","description":"The type of the content part.","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"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\".","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].cache_control.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].cache_control.ttl","typeLabel":"enum\u003cstring>"}},"required":["type"],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].cache_control","typeLabel":"object"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object"},"description":"The contents of the tool message.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content.oneOf.1","typeLabel":"Text content part · object[]"}],"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.content","typeLabel":"string | Text content part · object[]"},"tool_call_id":{"oneOf":[{"type":"string","description":"Tool call that this message is responding to.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.tool_call_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tool call that this message is responding to.","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.tool_call_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.tool_call_id","typeLabel":"string | null"},"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\".","isRequired":true,"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.cache_control.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"required":["type"],"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3.cache_control","typeLabel":"object"}},"uniqueKey":"prompt.messages.items.[INDEX].oneOf.3","typeLabel":"Tool message · object"}],"uniqueKey":"prompt.messages.items.[INDEX]","typeLabel":"System message · object | User message · object | Assistant message · object | Tool message · object"},"description":"Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content.","uniqueKey":"prompt.messages","typeLabel":"(System message · object | User message · object | Assistant message · object | Tool message · object)[]"},"model":{"oneOf":[{"type":"string","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","uniqueKey":"prompt.model.oneOf.0","typeLabel":"string"},{"type":"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","uniqueKey":"prompt.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt.model","typeLabel":"string | null"},"version":{"type":"string","uniqueKey":"prompt.version","typeLabel":"string"},"fallback_on_codes":{"type":"array","items":{"type":"integer","minimum":400,"maximum":599,"uniqueKey":"prompt.fallback_on_codes.items.[INDEX]","typeLabel":"integer"},"maxItems":20,"description":"HTTP status codes that trigger fallback. Enter up to 20 unique integers from 400 to 599. When omitted or empty, defaults to [408, 429, 500, 502, 503, 504, 529].","uniqueKey":"prompt.fallback_on_codes","typeLabel":"integer[]"}},"title":"PromptField","description":"Prompt configuration with model and messages. Use this instead of prompt_config.","isRequired":true,"uniqueKey":"prompt","typeLabel":"PromptField · object"},"created_by_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"created_by_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"created_by_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by_id","typeLabel":"string\u003cuuid> | null"},"updated_by_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"updated_by_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"updated_by_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_by_id","typeLabel":"string\u003cuuid> | null"},"description":{"oneOf":[{"type":"string","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","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"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","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"prompt_config":{"type":"object","properties":{"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","isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","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.","isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","description":"Text content part of a prompt message","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"}},"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"The image part of the prompt message. Only supported with vision models.","required":["type","image_url"],"properties":{"type":{"type":"string","enum":["image_url"],"isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"image_url":{"type":"object","properties":{"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"],"isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.image_url.url","typeLabel":"string"},"id":{"type":"string","format":"ulid","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$","readOnly":true,"description":"The orq.ai id of the image","uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.image_url.id","typeLabel":"string\u003culid>"},"detail":{"type":"string","description":"Specifies the detail level of the image. Currently only supported with OpenAI models","uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.image_url.detail","typeLabel":"string"}},"required":["url"],"isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.image_url","typeLabel":"object"}},"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["type","file"],"properties":{"type":{"type":"string","enum":["file"],"description":"The type of the content part. Always `file`.","isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"file":{"type":"object","properties":{"file_data":{"type":"string","description":"The file data as a data URI string in the format `data:\u003cmime-type>;base64,\u003cbase64-encoded-data>`. Example: `data:image/png;base64,iVBORw0KGgoAAAANS...`","uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.2.file.file_data","typeLabel":"string"},"uri":{"type":"string","description":"URL to the file. Only supported by Anthropic Claude models for PDF files.","uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.2.file.uri","typeLabel":"string"},"mimeType":{"type":"string","description":"MIME type of the file (e.g., application/pdf, image/png)","uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.2.file.mimeType","typeLabel":"string"},"filename":{"type":"string","description":"The name of the file, used when passing the file to the model as a string.","uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.2.file.filename","typeLabel":"string"}},"isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.2.file","typeLabel":"object"}},"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1.items.[INDEX]","typeLabel":"object"},"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.","isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.1","typeLabel":"object[]"},{"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.","isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].content","typeLabel":"string | object[] | null"},"tool_calls":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["function"],"isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].tool_calls.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].tool_calls.items.[INDEX].function.name","typeLabel":"string"},"arguments":{"type":"string","description":"JSON string arguments for the functions","isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].tool_calls.items.[INDEX].function.arguments","typeLabel":"string"}},"required":["name","arguments"],"isRequired":true,"uniqueKey":"prompt_config.messages.items.[INDEX].tool_calls.items.[INDEX].function","typeLabel":"object"},"id":{"type":"string","uniqueKey":"prompt_config.messages.items.[INDEX].tool_calls.items.[INDEX].id","typeLabel":"string"},"index":{"type":"number","uniqueKey":"prompt_config.messages.items.[INDEX].tool_calls.items.[INDEX].index","typeLabel":"number"}},"required":["type","function"],"uniqueKey":"prompt_config.messages.items.[INDEX].tool_calls.items.[INDEX]","typeLabel":"object"},"uniqueKey":"prompt_config.messages.items.[INDEX].tool_calls","typeLabel":"object[]"},"tool_call_id":{"oneOf":[{"type":"string","uniqueKey":"prompt_config.messages.items.[INDEX].tool_call_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"prompt_config.messages.items.[INDEX].tool_call_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_config.messages.items.[INDEX].tool_call_id","typeLabel":"string | null"}},"required":["role","content"],"uniqueKey":"prompt_config.messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"prompt_config.messages","typeLabel":"object[]"},"stream":{"type":"boolean","uniqueKey":"prompt_config.stream","typeLabel":"boolean"},"model":{"oneOf":[{"type":"string","uniqueKey":"prompt_config.model.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"prompt_config.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_config.model","typeLabel":"string | null"},"model_db_id":{"oneOf":[{"type":"string","uniqueKey":"prompt_config.model_db_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"prompt_config.model_db_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_config.model_db_id","typeLabel":"string | null"},"model_type":{"oneOf":[{"type":"string","enum":["chat","completion","embedding","image","tts","stt","rerank","ocr","moderation","vision",null],"description":"The modality of the model","uniqueKey":"prompt_config.model_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["chat","completion","embedding","image","tts","stt","rerank","ocr","moderation","vision",null],"description":"The modality of the model","uniqueKey":"prompt_config.model_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_config.model_type","typeLabel":"enum\u003cstring> | null"},"model_parameters":{"type":"object","properties":{"temperature":{"type":"number","description":"Only supported on `chat` and `completion` models.","uniqueKey":"prompt_config.model_parameters.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"Only supported on `chat` and `completion` models.","uniqueKey":"prompt_config.model_parameters.maxTokens","typeLabel":"number"},"topK":{"type":"number","description":"Only supported on `chat` and `completion` models.","uniqueKey":"prompt_config.model_parameters.topK","typeLabel":"number"},"topP":{"type":"number","description":"Only supported on `chat` and `completion` models.","uniqueKey":"prompt_config.model_parameters.topP","typeLabel":"number"},"frequencyPenalty":{"type":"number","description":"Only supported on `chat` and `completion` models.","uniqueKey":"prompt_config.model_parameters.frequencyPenalty","typeLabel":"number"},"presencePenalty":{"type":"number","description":"Only supported on `chat` and `completion` models.","uniqueKey":"prompt_config.model_parameters.presencePenalty","typeLabel":"number"},"numImages":{"type":"number","description":"Only supported on `image` models.","uniqueKey":"prompt_config.model_parameters.numImages","typeLabel":"number"},"seed":{"type":"number","description":"Best effort deterministic seed for the model. Currently only OpenAI models support these","uniqueKey":"prompt_config.model_parameters.seed","typeLabel":"number"},"format":{"type":"string","enum":["url","b64_json","text","json_object"],"description":"Only supported on `image` models.","uniqueKey":"prompt_config.model_parameters.format","typeLabel":"enum\u003cstring>"},"dimensions":{"type":"string","description":"Only supported on `image` models.","uniqueKey":"prompt_config.model_parameters.dimensions","typeLabel":"string"},"quality":{"type":"string","description":"Only supported on `image` models.","uniqueKey":"prompt_config.model_parameters.quality","typeLabel":"string"},"style":{"type":"string","description":"Only supported on `image` models.","uniqueKey":"prompt_config.model_parameters.style","typeLabel":"string"},"responseFormat":{"oneOf":[{"type":"object","description":"An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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.","required":["type","json_schema"],"properties":{"type":{"type":"string","enum":["json_schema"],"isRequired":true,"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.type","typeLabel":"enum\u003cstring>"},"json_schema":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.json_schema.name","typeLabel":"string"},"schema":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.json_schema.schema.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.json_schema.schema","typeLabel":"object"},"description":{"oneOf":[{"type":"string","uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.json_schema.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.json_schema.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.json_schema.description","typeLabel":"string | null"},"strict":{"type":"boolean","uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.json_schema.strict","typeLabel":"boolean"}},"required":["name","schema"],"isRequired":true,"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.json_schema","typeLabel":"object"},"display_name":{"type":"string","uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0.display_name","typeLabel":"string"}},"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.0","typeLabel":"object"},{"type":"object","description":"An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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.","required":["type"],"properties":{"type":{"type":"string","enum":["json_object"],"isRequired":true,"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.1","typeLabel":"object"},{"type":"object","description":"An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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.","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.2","typeLabel":"object"},{"type":"string","description":"An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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.","enum":["mp3","opus","aac","flac","wav","pcm"],"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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.","enum":["url","base64_json"],"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"string","description":"An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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.","enum":["json","text","srt","verbose_json","vtt"],"uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.5","typeLabel":"enum\u003cstring>"},{"type":"null","description":"An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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.","uniqueKey":"prompt_config.model_parameters.responseFormat.oneOf.6","typeLabel":"null"}],"uniqueKey":"prompt_config.model_parameters.responseFormat","typeLabel":"object · object · object · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · null"},"cacheControl":{"oneOf":[{"type":"object","properties":{"type":{"description":"Create a cache control breakpoint. Accepts only the value \"ephemeral\".","enum":["ephemeral"],"type":"string","isRequired":true,"uniqueKey":"prompt_config.model_parameters.cacheControl.oneOf.0.type","typeLabel":"enum\u003cstring>"},"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models.","uniqueKey":"prompt_config.model_parameters.cacheControl.oneOf.0.ttl","typeLabel":"enum\u003cstring>"}},"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.","uniqueKey":"prompt_config.model_parameters.cacheControl.oneOf.0","typeLabel":"object"},{"type":"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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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.","uniqueKey":"prompt_config.model_parameters.cacheControl.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_config.model_parameters.cacheControl","typeLabel":"object | null"},"photoRealVersion":{"type":"string","enum":["v1","v2"],"description":"The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider","uniqueKey":"prompt_config.model_parameters.photoRealVersion","typeLabel":"enum\u003cstring>"},"encoding_format":{"type":"string","enum":["float","base64"],"description":"The format to return the embeddings","uniqueKey":"prompt_config.model_parameters.encoding_format","typeLabel":"enum\u003cstring>"},"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.","uniqueKey":"prompt_config.model_parameters.reasoningEffort","typeLabel":"enum\u003cstring>"},"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` ","uniqueKey":"prompt_config.model_parameters.budgetTokens","typeLabel":"number"},"verbosity":{"description":"Controls the verbosity of the model output.","enum":["low","medium","high"],"type":"string","uniqueKey":"prompt_config.model_parameters.verbosity","typeLabel":"enum\u003cstring>"},"thinkingLevel":{"type":"string","enum":["minimal","low","medium","high"],"description":"The level of thinking to use for the model. Only supported by `Google AI`","uniqueKey":"prompt_config.model_parameters.thinkingLevel","typeLabel":"enum\u003cstring>"}},"description":"Model Parameters: Not all parameters apply to every model","uniqueKey":"prompt_config.model_parameters","typeLabel":"object"},"provider":{"oneOf":[{"type":"string","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],"uniqueKey":"prompt_config.provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"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],"uniqueKey":"prompt_config.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_config.provider","typeLabel":"enum\u003cstring> | null"},"integration_id":{"oneOf":[{"type":"string","description":"The ID of the integration to use","uniqueKey":"prompt_config.integration_id.oneOf.0","typeLabel":"string"},{"type":"string","description":"The ID of the integration to use","format":"ulid","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$","uniqueKey":"prompt_config.integration_id.oneOf.1","typeLabel":"string\u003culid>"},{"type":"null","description":"The ID of the integration to use","uniqueKey":"prompt_config.integration_id.oneOf.2","typeLabel":"null"}],"uniqueKey":"prompt_config.integration_id","typeLabel":"string | string\u003culid> | null"},"version":{"type":"string","uniqueKey":"prompt_config.version","typeLabel":"string"}},"required":["messages"],"deprecated":true,"description":"[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema.","uniqueKey":"prompt_config","typeLabel":"object"},"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)"],"uniqueKey":"metadata.use_cases.items.[INDEX]","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"metadata.use_cases","typeLabel":"enum\u003cstring>[]"},"language":{"oneOf":[{"type":"string","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","uniqueKey":"metadata.language.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"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","uniqueKey":"metadata.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata.language","typeLabel":"enum\u003cstring> | null"}},"default":{"language":"English"},"uniqueKey":"metadata","typeLabel":"object"}},"required":["_id","type","owner","domain_id","created","updated","display_name","prompt"],"title":"Prompt","description":"A prompt entity with configuration, metadata, and versioning.","uniqueKey":"","typeLabel":"Prompt · object"},"examples":{"Example":{"title":"Example","value":{"_id":"\u003cstring>","type":"prompt","owner":"\u003cstring>","domain_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created":"\u003cstring>","updated":"\u003cstring>","display_name":"\u003cstring>","prompt":{"name":"\u003cstring>","audio":{"voice":"alloy","format":"wav"},"frequency_penalty":123,"max_tokens":123,"max_completion_tokens":123,"logprobs":true,"top_logprobs":10,"n":2,"presence_penalty":123,"response_format":{"type":"text"},"reasoning_effort":"none","verbosity":"\u003cstring>","seed":123,"stop":"\u003cstring>","stream_options":{"include_usage":true},"thinking":{"type":"disabled"},"temperature":1,"top_p":0.5,"top_k":123,"tool_choice":"none","parallel_tool_calls":true,"modalities":["text"],"guardrails":[{"id":"orq_pii_detection","execute_on":"input"}],"plugins":[{"id":"pii_redaction","language":"\u003cstring>","regions":["\u003cstring>"],"entities":["\u003cstring>"],"entity_thresholds":{},"threshold":0.5,"on_failure":"block"}],"fallbacks":[{"model":"openai/gpt-5.4-mini"}],"retry":{"count":3,"on_codes":[429,500,502,503,504]},"cache":{"type":"exact_match","ttl":3600},"load_balancer":{"type":"weight_based","models":[{"model":"openai/gpt-4o","weight":0.7},{"model":"anthropic/claude-3-5-sonnet","weight":0.3}]},"timeout":{"call_timeout":30000},"cache_control":{"type":"ephemeral","ttl":"5m"},"prompt_cache_key":"\u003cstring>","messages":[{"role":"system","content":"\u003cstring>","name":"\u003cstring>"}],"model":"openai/gpt-5.6-sol","version":"\u003cstring>","fallback_on_codes":[499]},"created_by_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","updated_by_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","description":"\u003cstring>","prompt_config":{"messages":[{"role":"system","content":"\u003cstring>","tool_calls":[{"type":"function","function":{"name":"\u003cstring>","arguments":"\u003cstring>"},"id":"\u003cstring>","index":123}],"tool_call_id":"\u003cstring>"}],"stream":true,"model":"\u003cstring>","model_db_id":"\u003cstring>","model_type":"chat","model_parameters":{"temperature":123,"maxTokens":123,"topK":123,"topP":123,"frequencyPenalty":123,"presencePenalty":123,"numImages":123,"seed":123,"format":"url","dimensions":"\u003cstring>","quality":"\u003cstring>","style":"\u003cstring>","responseFormat":{"type":"json_schema","json_schema":{"name":"\u003cstring>","schema":{},"description":"\u003cstring>","strict":true},"display_name":"\u003cstring>"},"cacheControl":{"type":"ephemeral","ttl":"5m"},"photoRealVersion":"v1","encoding_format":"float","reasoningEffort":"none","budgetTokens":123,"verbosity":"low","thinkingLevel":"minimal"},"provider":"openai","integration_id":"\u003cstring>","version":"\u003cstring>"},"metadata":{"language":"English"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c7531b10-220e-48ae-9b1a-6f116cda56c1":{"description":"Authentication required. See https://docs.orq.ai/reference/errors for the error codes.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"integer","description":"gRPC status code, when the service reports one.","uniqueKey":"code","typeLabel":"integer"},"details":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.items.[INDEX]","typeLabel":"any"},"description":"Additional error details, when the service reports any.","uniqueKey":"details","typeLabel":"any[]"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":123,"details":["\u003cunknown>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"abf6e733-95ad-447d-88aa-8cf1c8d82121":{"description":"The resource does not exist. See https://docs.orq.ai/reference/errors for the error codes.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"integer","description":"gRPC status code, when the service reports one.","uniqueKey":"code","typeLabel":"integer"},"details":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.items.[INDEX]","typeLabel":"any"},"description":"Additional error details, when the service reports any.","uniqueKey":"details","typeLabel":"any[]"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":123,"details":["\u003cunknown>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"56c5c662-cbe9-4db2-aca7-c481d5fb2d5b":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"ApiKey"}}},"servers":{"0d120802-8c97-467e-bd0f-d8f52b0765db":{"url":"https://my.orq.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"orqai","siteName":"Orq.ai Documentation","title":"Retrieve a prompt - Orq.ai Documentation","contextualStarterQuestions":[{"_id":"6ab7db6d04e7bafd5033f80e","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"Where do I find my prompts?","status":"active","generatedBy":"contextual","path":"reference/prompts/retrieve-a-prompt","createdAt":"2026-09-26T14:49:17.089Z","updatedAt":"2026-09-26T14:49:17.089Z","__v":0},{"_id":"6ab7db6d04e7bafd5033f80d","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"What is a prompt object?","status":"active","generatedBy":"contextual","path":"reference/prompts/retrieve-a-prompt","createdAt":"2026-09-26T14:49:17.089Z","updatedAt":"2026-09-26T14:49:17.089Z","__v":0},{"_id":"6ab7db6d04e7bafd5033f80c","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"How do I retrieve a prompt?","status":"active","generatedBy":"contextual","path":"reference/prompts/retrieve-a-prompt","createdAt":"2026-09-26T14:49:17.089Z","updatedAt":"2026-09-26T14:49:17.089Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-26T14:48:30.857Z","originalFileLocation":"reference/prompts/retrieve-a-prompt.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves a prompt object\">\u003cmeta data-mint-head name=\"application-name\" content=\"Orq.ai Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a prompt - Orq.ai Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a prompt object\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orq.ai Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orqai.mintlify.app/_mintlify/api/og/v2?division=Prompts\u0026amp;title=Retrieve+a+prompt\u0026amp;description=Retrieves+a+prompt+object\u0026amp;theme=0116d0baa6ba6403f431e631\u0026amp;signature=9c1de19cafb5cb46fed23229e90dfeab66aecc16582704454994157894564f6f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a prompt - Orq.ai Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a prompt object\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orqai.mintlify.app/_mintlify/api/og/v2?division=Prompts\u0026amp;title=Retrieve+a+prompt\u0026amp;description=Retrieves+a+prompt+object\u0026amp;theme=0116d0baa6ba6403f431e631\u0026amp;signature=9c1de19cafb5cb46fed23229e90dfeab66aecc16582704454994157894564f6f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orq.ai Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#027f6b\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Orq.ai\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@orq_ai\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"language\" content=\"English\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/prompts/retrieve-a-prompt.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orq.ai/#organization\",\"name\":\"Orq.ai\",\"legalName\":\"Orq.AI Holding B.V.\",\"url\":\"https://orq.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.orq.ai/images/Orq_ai_Symbol_Dark.svg\"},\"sameAs\":[\"https://github.com/orq-ai\",\"https://x.com/orq_ai\",\"https://www.linkedin.com/company/orqai/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orq.ai#website\",\"name\":\"Orq.ai Documentation\",\"url\":\"https://docs.orq.ai\",\"publisher\":{\"@id\":\"https://docs.orq.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt#webpage\",\"url\":\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt\",\"name\":\"Retrieve a prompt\",\"description\":\"Retrieves a prompt object\",\"dateModified\":\"2026-09-26T14:48:30.857Z\",\"isPartOf\":{\"@id\":\"https://docs.orq.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform APIs\",\"item\":\"https://docs.orq.ai/reference/agent-feedback/submit-feedback\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Prompts\",\"item\":\"https://docs.orq.ai/reference/prompts/list-all-prompts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a prompt\",\"item\":\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt#apireference\",\"headline\":\"Retrieve a prompt\",\"name\":\"Retrieve a prompt\",\"description\":\"Retrieves a prompt object\",\"url\":\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orq.ai/reference/prompts/retrieve-a-prompt#webpage\"},\"dateModified\":\"2026-09-26T14:48:30.857Z\",\"publisher\":{\"@id\":\"https://docs.orq.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orq.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orq.ai Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Orq.ai Documentation","nav":{"global":null,"tabs":[{"tab":"AI Gateway","pages":[{"title":"AI Gateway","href":"/ai-gateway/get-started/introduction"}]},{"tab":"AI Observability","pages":[{"title":"AI Observability","href":"/ai-studio/observability/quickstart"}]},{"tab":"Managed agents","pages":[{"title":"Managed agents","href":"/ai-studio/ai-engineering/quickstart"}]},{"tab":"Administration","pages":[{"title":"Administration","href":"/ai-studio/organization/workspace-settings"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/ai-studio/integrations/overview"}]},{"tab":"API Reference","groups":[{"group":"Orq SDK","pages":[{"title":"Orq SDKs","sidebarTitle":"Overview","href":"/reference/client-libraries"},{"group":"SDK Reference","pages":[{"title":"Agents SDK Reference","href":"/reference/sdk/agents"},{"title":"Agents.External SDK Reference","sidebarTitle":"External","href":"/reference/sdk/external"},{"title":"Alerts SDK Reference","href":"/reference/sdk/alerts"},{"title":"Responses SDK Reference","href":"/reference/sdk/responses"},{"title":"Annotations SDK Reference","href":"/reference/sdk/annotations"},{"title":"Annotation Queues SDK Reference","href":"/reference/sdk/annotationqueues"},{"title":"API Keys SDK Reference","href":"/reference/sdk/apikeys"},{"title":"AuditLogDestinations SDK Reference","href":"/reference/sdk/auditlogdestinations"},{"title":"Budgets SDK Reference","href":"/reference/sdk/budgets"},{"title":"Chunking SDK Reference","href":"/reference/sdk/chunking"},{"title":"Datasets SDK Reference","href":"/reference/sdk/datasets"},{"title":"Deployments SDK Reference","href":"/reference/sdk/deployments"},{"title":"Environments SDK Reference","href":"/reference/sdk/environments"},{"title":"Evals SDK Reference","href":"/reference/sdk/evals"},{"title":"Feedback SDK Reference","href":"/reference/sdk/feedback"},{"title":"Files SDK Reference","href":"/reference/sdk/files"},{"title":"FileSystems SDK Reference","href":"/reference/sdk/filesystems"},{"title":"Guardrail Rules SDK Reference","href":"/reference/sdk/guardrailrules"},{"title":"Hub SDK Reference","href":"/reference/sdk/hub"},{"title":"Identities SDK Reference","href":"/reference/sdk/identities"},{"title":"Knowledge SDK Reference","href":"/reference/sdk/knowledge"},{"title":"Logs SDK Reference","href":"/reference/sdk/logs"},{"title":"Management Keys SDK Reference","href":"/reference/sdk/managementkeys"},{"title":"MCP Gateways SDK Reference","href":"/reference/sdk/mcpgateways"},{"title":"MCP Servers SDK Reference","href":"/reference/sdk/mcpservers"},{"title":"Memory Stores SDK Reference","href":"/reference/sdk/memorystores"},{"title":"Model Catalog SDK Reference","href":"/reference/sdk/modelcatalog"},{"title":"ModelFusions SDK Reference","href":"/reference/sdk/modelfusions"},{"title":"Models SDK Reference","href":"/reference/sdk/models"},{"title":"Monitors SDK Reference","href":"/reference/sdk/monitors"},{"title":"Notifiers SDK Reference","href":"/reference/sdk/notifiers"},{"title":"Agents.Responses SDK Reference","sidebarTitle":"Responses","href":"/reference/sdk/orqresponses"},{"title":"PII SDK Reference","href":"/reference/sdk/pii"},{"title":"Policies SDK Reference","href":"/reference/sdk/policies"},{"title":"Projects SDK Reference","href":"/reference/sdk/projects"},{"title":"Prompts SDK Reference","href":"/reference/sdk/prompts"},{"title":"Reporting SDK Reference","href":"/reference/sdk/reporting"},{"title":"Routing Rules SDK Reference","href":"/reference/sdk/routingrules"},{"title":"Schedules SDK Reference","href":"/reference/sdk/schedules"},{"title":"Sessions SDK Reference","href":"/reference/sdk/sessions"},{"title":"Skills SDK Reference","href":"/reference/sdk/skills"},{"title":"Smart Routers SDK Reference","href":"/reference/sdk/smartrouters"},{"title":"Telemetry SDK Reference","href":"/reference/sdk/telemetry"},{"title":"Tools SDK Reference","href":"/reference/sdk/tools"},{"title":"Traces SDK Reference","href":"/reference/sdk/traces"},{"title":"Users SDK Reference","href":"/reference/sdk/users"},{"title":"Views SDK Reference","href":"/reference/sdk/views"},{"title":"Webhooks SDK Reference","href":"/reference/sdk/webhooks"},{"title":"Websearch SDK Reference","href":"/reference/sdk/websearch"},{"title":"Wikis SDK Reference","href":"/reference/sdk/wikis"},{"title":"Workspaces SDK Reference","href":"/reference/sdk/workspaces"},{"title":"Workspace Security SDK Reference","href":"/reference/sdk/workspacesecurity"},{"title":"Workspace Settings SDK Reference","href":"/reference/sdk/workspacesettings"},{"group":"Router","pages":[{"title":"Router SDK Reference","href":"/reference/sdk/router"},{"title":"Router.Completions SDK Reference","sidebarTitle":"Completions","href":"/reference/sdk/completions"},{"title":"Router.Chat.Completions SDK Reference","sidebarTitle":"Completions","href":"/reference/sdk/orqcompletions"},{"title":"Router.Embeddings SDK Reference","sidebarTitle":"Embeddings","href":"/reference/sdk/embeddings"},{"title":"Router.Audio.Speech SDK Reference","sidebarTitle":"Speech","href":"/reference/sdk/speech"},{"title":"Router.Audio.Transcriptions SDK Reference","sidebarTitle":"Transcriptions","href":"/reference/sdk/transcriptions"},{"title":"Router.Audio.Translations SDK Reference","sidebarTitle":"Translations","href":"/reference/sdk/translations"},{"title":"Router.Images.Generations SDK Reference","sidebarTitle":"Generations","href":"/reference/sdk/generations"},{"title":"Router.Images.Edits SDK Reference","sidebarTitle":"Edits","href":"/reference/sdk/edits"},{"title":"Router.Images.Variations SDK Reference","sidebarTitle":"Variations","href":"/reference/sdk/variations"},{"title":"Router.Moderations SDK Reference","sidebarTitle":"Moderations","href":"/reference/sdk/moderations"},{"title":"Router.Rerank SDK Reference","sidebarTitle":"Rerank","href":"/reference/sdk/rerank"},{"title":"Router.Classify SDK Reference","sidebarTitle":"Classify","href":"/reference/sdk/classify"},{"title":"Router.Decisions SDK Reference","sidebarTitle":"Decisions","href":"/reference/sdk/decisions"}]}]},{"title":"API Error Codes","href":"/reference/errors"},{"title":"Base URLs","href":"/reference/base-urls"}]},{"group":"Terminal \u0026 Agents","pages":[{"title":"Orq CLI","sidebarTitle":"Orq CLI","tag":"Beta","href":"/reference/cli"},{"title":"Orq MCP Server tools and quickstart","sidebarTitle":"Orq MCP","href":"/ai-studio/integrations/code-assistants/orq-mcp"},{"title":"Orq Skills for code assistants","sidebarTitle":"Orq Skills","href":"/ai-studio/integrations/code-assistants/orq-skills"}]},{"group":"Terraform","pages":[{"title":"Terraform","sidebarTitle":"Overview","href":"/reference/terraform"},{"title":"Terraform Quickstart","sidebarTitle":"Quickstart","href":"/reference/terraform/quickstart"},{"title":"Terraform Resources","sidebarTitle":"Resources","href":"/reference/terraform/resources"},{"title":"Importing an Existing Workspace","sidebarTitle":"Importing resources","href":"/reference/terraform/importing"},{"title":"Enterprise Baseline","sidebarTitle":"Enterprise baseline","href":"/reference/terraform/enterprise-baseline"}]},{"group":"Platform APIs","pages":[{"group":"Agent Feedback","pages":[{"openapi":"post /v3/submit-feedback","title":"Submit feedback","href":"/reference/agent-feedback/submit-feedback"}]},{"group":"Agent Schedules","pages":[{"openapi":"get /v3/agents/{agent_key}/schedules","title":"List schedules","href":"/reference/agent-schedules/list-schedules"},{"openapi":"post /v3/agents/{agent_key}/schedules","title":"Create schedule","href":"/reference/agent-schedules/create-schedule"},{"openapi":"get /v3/agents/{agent_key}/schedules/{schedule_id}","title":"Retrieve schedule","href":"/reference/agent-schedules/retrieve-schedule"},{"openapi":"delete /v3/agents/{agent_key}/schedules/{schedule_id}","title":"Delete schedule","href":"/reference/agent-schedules/delete-schedule"},{"openapi":"patch /v3/agents/{agent_key}/schedules/{schedule_id}","title":"Update schedule","href":"/reference/agent-schedules/update-schedule"},{"openapi":"post /v3/agents/{agent_key}/schedules/{schedule_id}/execution","title":"Trigger schedule execution","href":"/reference/agent-schedules/trigger-schedule-execution"}]},{"group":"Agents","pages":[{"openapi":"get /v2/agents","title":"List agents","href":"/reference/agents/list-agents"},{"openapi":"post /v2/agents","title":"Create agent","href":"/reference/agents/create-agent"},{"openapi":"get /v2/agents/{agent_key}","title":"Retrieve agent","href":"/reference/agents/retrieve-agent"},{"openapi":"delete /v2/agents/{agent_key}","title":"Delete agent","href":"/reference/agents/delete-agent"},{"openapi":"patch /v2/agents/{agent_key}","title":"Update agent","href":"/reference/agents/update-agent"},{"group":"External Agents","pages":[{"openapi":"get /v2/agents/external","title":"List external agents","href":"/reference/agents/list-external-agents"},{"openapi":"post /v2/agents/external","title":"Create external agent","href":"/reference/agents/create-external-agent"},{"openapi":"get /v2/agents/external/{agent_key}","title":"Retrieve external agent","href":"/reference/agents/retrieve-external-agent"},{"openapi":"patch /v2/agents/external/{agent_key}","title":"Update external agent","href":"/reference/agents/update-external-agent"},{"openapi":"delete /v2/agents/external/{agent_key}","title":"Delete external agent","href":"/reference/agents/delete-external-agent"},{"openapi":"post /v2/agents/external/{agent_key}:refreshCard","title":"Refresh external agent card","href":"/reference/agents/refresh-external-agent-card"},{"openapi":"post /v2/agents/external/{agent_key}:testConnection","title":"Test external agent connection","href":"/reference/agents/test-external-agent-connection"}]},{"openapi":"post /v3/router/responses","title":"Invoke an agent","href":"/reference/agents/invoke-agent"},{"group":"Legacy","pages":[{"openapi":"post /v2/agents/{agent_key}/responses","title":"Create an agent response","deprecated":true,"href":"/reference/agents/create-response"},{"openapi":"get /v2/agents/{agent_key}/responses/{task_id}","title":"Get response","href":"/reference/agents/get-response"},{"openapi":"post /v2/agents/{key}/task","deprecated":true,"title":"Execute an agent task","href":"/reference/agents/execute-an-agent-task"},{"openapi":"post /v2/agents/run","deprecated":true,"title":"Run an agent with configuration","href":"/reference/agents/run-an-agent-with-configuration"},{"openapi":"post /v2/agents/stream-run","deprecated":true,"title":"Run agent with streaming response","href":"/reference/agents/run-agent-with-streaming-response"},{"openapi":"post /v2/agents/{key}/stream-task","deprecated":true,"title":"Stream agent execution in real-time","href":"/reference/agents/stream-agent-execution-in-real-time"}]}]},{"group":"Annotation Queues","pages":[{"openapi":"get /v2/annotation-queues","title":"List annotation queues","href":"/reference/annotation-queues/list-annotation-queues"},{"openapi":"post /v2/annotation-queues","title":"Create an annotation queue","href":"/reference/annotation-queue/create-an-annotation-queue"},{"openapi":"get /v2/annotation-queues/{annotation_queue_id}","title":"Retrieve an annotation queue","href":"/reference/annotation-queues/retrieve-an-annotation-queue"},{"openapi":"patch /v2/annotation-queues/{annotation_queue_id}","title":"Update an annotation queue","href":"/reference/annotation-queue/edit-an-annotation-queue"},{"openapi":"delete /v2/annotation-queues/{annotation_queue_id}","title":"Delete an annotation queue","href":"/reference/annotation-queue/delete-an-annotation-queue"},{"openapi":"delete /v2/annotation-queues/{annotation_queue_id}/clear","title":"Clear an annotation queue","href":"/reference/annotation-queues/delete-all-items"},{"openapi":"post /v2/annotation-queues/{annotation_queue_id}/items","title":"Add items to an annotation queue","href":"/reference/annotation-queue/add-items-to-an-annotation-queue"},{"openapi":"post /v2/annotation-queues/{annotation_queue_id}/items/remove","title":"Remove items from an annotation queue","href":"/reference/annotation-queue/remove-annotation-queue-items"},{"openapi":"get /v2/annotation-queues/{annotation_queue_id}/items","title":"Query items from an annotation queue","href":"/reference/annotation-queue/query-items-from-an-annotation-queue"},{"openapi":"get /v2/annotation-queues/{annotation_queue_id}/items/{item_id}","title":"Retrieve an annotation queue item","href":"/reference/annotation-queue/retrieve-an-annotation-queue-item"}]},{"group":"Annotations","pages":[{"openapi":"post /v2/traces/{trace_id}/spans/{span_id}/annotation","title":"Annotate a span","href":"/reference/annotations/annotate-a-span"},{"openapi":"delete /v2/traces/{trace_id}/spans/{span_id}/annotation","title":"Remove an annotation from a span","href":"/reference/annotations/remove-an-annotation-from-a-span"}]},{"group":"Audio","pages":[{"openapi":"post /v2/router/audio/speech","title":"Create speech","href":"/reference/audio/create-speech"},{"openapi":"post /v2/router/audio/transcriptions","title":"Create transcription","href":"/reference/audio/create-transcription"},{"openapi":"post /v2/router/audio/translations","title":"Create translation","href":"/reference/audio/create-translation"}]},{"group":"Chat","pages":[{"openapi":"post /v2/router/chat/completions","title":"Create chat completion","href":"/reference/chat/create-chat-completion"}]},{"group":"Chunking","pages":[{"openapi":"post /v2/chunking","title":"Parse text","href":"/reference/chunking/parse-text"}]},{"group":"Classify","pages":[{"openapi":"post /v3/router/classify","deprecated":true,"title":"Classify","href":"/reference/classify/create-classify"}]},{"group":"Completions","pages":[{"openapi":"post /v2/router/completions","title":"Create completion","href":"/reference/completions/create-completion"}]},{"group":"Datasets","pages":[{"openapi":"get /v2/datasets","title":"List datasets","href":"/reference/datasets/list-datasets"},{"openapi":"post /v2/datasets","title":"Create a dataset","href":"/reference/datasets/create-a-dataset"},{"openapi":"get /v2/datasets/{dataset_id}","title":"Retrieve a dataset","href":"/reference/datasets/retrieve-a-dataset"},{"openapi":"delete /v2/datasets/{dataset_id}","title":"Delete a dataset","href":"/reference/datasets/delete-a-dataset"},{"openapi":"patch /v2/datasets/{dataset_id}","title":"Update a dataset","href":"/reference/datasets/update-a-dataset"},{"openapi":"get /v2/datasets/{dataset_id}/datapoints","title":"List datapoints","href":"/reference/datasets/list-datapoints"},{"openapi":"post /v2/datasets/{dataset_id}/datapoints","title":"Create a datapoint","href":"/reference/datasets/create-a-datapoint"},{"openapi":"get /v2/datasets/{dataset_id}/datapoints/{datapoint_id}","title":"Retrieve a datapoint","href":"/reference/datasets/retrieve-a-datapoint"},{"openapi":"delete /v2/datasets/{dataset_id}/datapoints/{datapoint_id}","title":"Delete a datapoint","href":"/reference/datasets/delete-a-datapoint"},{"openapi":"patch /v2/datasets/{dataset_id}/datapoints/{datapoint_id}","title":"Update a datapoint","href":"/reference/datasets/update-a-datapoint"},{"openapi":"delete /v2/datasets/{dataset_id}/clear","title":"Delete all datapoints","href":"/reference/datasets/delete-all-datapoints"}]},{"group":"Decisions","pages":[{"openapi":"post /v3/router/decisions","title":"Create decisions","href":"/reference/decisions/create-decisions"}]},{"group":"Deployments","pages":[{"openapi":"get /v2/deployments","title":"List all deployments","href":"/reference/deployments/list-all-deployments"},{"openapi":"get /v2/deployments/{keyOrID}/versions","title":"List deployment versions","href":"/reference/deployments/list-deployment-versions"},{"title":"Invoke a deployment","openapi":"post /v2/deployments/invoke","href":"/reference/deployments/invoke"},{"openapi":"post /v2/deployments/stream","title":"Stream a deployment","href":"/reference/deployments/stream"},{"openapi":"post /v2/deployments/get_config","title":"Get config","href":"/reference/deployments/get-config"}]},{"group":"Embeddings","pages":[{"openapi":"post /v2/router/embeddings","title":"Create embeddings","href":"/reference/embeddings/create-embeddings"}]},{"group":"Evaluators","pages":[{"openapi":"get /v2/evaluators","title":"Get all Evaluators","href":"/reference/evals/get-all-evaluators"},{"openapi":"get /v2/evaluators/{id}","title":"Retrieve an Evaluator","href":"/reference/evals/retrieve-an-evaluator"},{"openapi":"post /v2/evaluators","title":"Create an Evaluator","href":"/reference/evals/create-an-evaluator"},{"openapi":"delete /v2/evaluators/{id}","title":"Delete an Evaluator","href":"/reference/evals/delete-an-evaluator"},{"openapi":"patch /v2/evaluators/{id}","title":"Update an Evaluator","href":"/reference/evals/update-an-evaluator"},{"openapi":"post /v3/evaluators/{id}/invoke","title":"Invoke a Custom Evaluator","href":"/reference/evals/invoke-a-custom-evaluator"},{"openapi":"get /v2/evaluators/{id}/versions","title":"List evaluator versions","href":"/reference/evals/list-evaluator-versions"},{"openapi":"post /v2/evaluators/{id}/duplicate","title":"Duplicate an Evaluator","href":"/reference/evals/duplicate-an-evaluator"},{"openapi":"get /v2/evaluators/{id}/versions/{version_id}","title":"Get evaluator version","href":"/reference/evals/get-evaluator-version"}]},{"group":"Files","pages":[{"openapi":"get /v2/files","title":"List all files","href":"/reference/files/list-all-files"},{"openapi":"post /v2/files","title":"Upload a file","href":"/reference/files/upload-a-file"},{"openapi":"get /v2/files/{file_id}","title":"Retrieve a file","href":"/reference/files/retrieve-a-file"},{"openapi":"delete /v2/files/{file_id}","title":"Delete a file","href":"/reference/files/delete-a-file"},{"openapi":"patch /v2/files/{file_id}","title":"Update a file","href":"/reference/files/update-a-file"},{"openapi":"get /v2/files/{file_id_or_path}/content","title":"Download file content","href":"/reference/files/download-file-content"}]},{"group":"Feedback","pages":[{"openapi":"post /v2/feedback","title":"Submit feedback","href":"/reference/feedback/post-v2feedback"},{"openapi":"post /v2/feedback/remove","title":"Remove feedback","href":"/reference/feedback/post-v2feedbackremove"}]},{"group":"File Systems","pages":[{"openapi":"get /v2/file-systems","title":"List file systems","href":"/reference/file-systems/list-file-systems"},{"openapi":"post /v2/file-systems","title":"Create file system","href":"/reference/file-systems/create-file-system"},{"openapi":"get /v2/file-systems/{file_system_key}","title":"Retrieve file system","href":"/reference/file-systems/retrieve-file-system"},{"openapi":"delete /v2/file-systems/{file_system_key}","title":"Delete file system","href":"/reference/file-systems/delete-file-system"},{"openapi":"patch /v2/file-systems/{file_system_key}","title":"Update file system","href":"/reference/file-systems/update-file-system"},{"openapi":"get /v2/file-systems/{file_system_key}/files","title":"List files","href":"/reference/file-systems/list-files"},{"openapi":"delete /v2/file-systems/{file_system_key}/files","title":"Delete file","href":"/reference/file-systems/delete-file"},{"openapi":"post /v2/file-systems/{file_system_key}/files/move","title":"Move file","href":"/reference/file-systems/move-file"},{"openapi":"get /v2/file-systems/{file_system_key}/files/stat","title":"Stat file","href":"/reference/file-systems/stat-file"},{"openapi":"post /v2/file-systems/{file_system_key}/folders","title":"Create folder","href":"/reference/file-systems/create-folder"}]},{"group":"Guardrail Rules","pages":[{"openapi":"get /v2/guardrail-rules","title":"List guardrail rules","href":"/reference/guardrail-rules/list-guardrail-rules"},{"openapi":"post /v2/guardrail-rules","title":"Create a guardrail rule","href":"/reference/guardrail-rules/create-guardrail-rule"},{"openapi":"get /v2/guardrail-rules/{guardrail_rule_id}","title":"Retrieve a guardrail rule","href":"/reference/guardrail-rules/get-guardrail-rule"},{"openapi":"delete /v2/guardrail-rules/{guardrail_rule_id}","title":"Delete a guardrail rule","href":"/reference/guardrail-rules/delete-guardrail-rule"},{"openapi":"patch /v2/guardrail-rules/{guardrail_rule_id}","title":"Update a guardrail rule","href":"/reference/guardrail-rules/update-guardrail-rule"},{"openapi":"get /v2/guardrail-rules/used-guardrails","title":"List guardrails used by guardrail rules","href":"/reference/guardrail-rules/list-used-guardrails"}]},{"group":"Hub","pages":[{"openapi":"get /v2/hub/search","title":"Search hub items","href":"/reference/hub/search-hub-items"},{"openapi":"get /v2/hub/{id}","title":"Get a hub item","href":"/reference/hub/get-a-hub-item"}]},{"group":"Images","pages":[{"openapi":"post /v2/router/images/generations","title":"Create image","href":"/reference/images/create-image"},{"openapi":"post /v2/router/images/edits","title":"Create image edit","href":"/reference/images/create-image-edit"},{"openapi":"post /v2/router/images/variations","title":"Create image variation","href":"/reference/images/create-image-variation"}]},{"group":"Knowledge Bases","pages":[{"openapi":"get /v2/knowledge","title":"List all knowledge bases","href":"/reference/knowledge-bases/list-all-knowledge-bases"},{"openapi":"post /v2/knowledge","title":"Create a knowledge base","href":"/reference/knowledge-bases/create-a-knowledge"},{"openapi":"get /v2/knowledge/{knowledge_id}","title":"Retrieve a knowledge base","href":"/reference/knowledge-bases/retrieves-a-knowledge-base"},{"openapi":"delete /v2/knowledge/{knowledge_id}","title":"Delete a knowledge base","href":"/reference/knowledge-bases/deletes-a-knowledge"},{"openapi":"patch /v2/knowledge/{knowledge_id}","title":"Update a knowledge base","href":"/reference/knowledge-bases/updates-a-knowledge"},{"openapi":"post /v2/knowledge/{knowledge_id}/search","title":"Search knowledge base","href":"/reference/knowledge-bases/search-knowledge-base"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources","title":"List all datasources","href":"/reference/knowledge-bases/list-all-datasources"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources","title":"Create a new datasource","href":"/reference/knowledge-bases/create-a-new-datasource"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources/{datasource_id}","title":"Retrieve a datasource","href":"/reference/knowledge-bases/retrieve-a-datasource"},{"openapi":"delete /v2/knowledge/{knowledge_id}/datasources/{datasource_id}","title":"Delete a datasource","href":"/reference/knowledge-bases/deletes-a-datasource"},{"openapi":"patch /v2/knowledge/{knowledge_id}/datasources/{datasource_id}","title":"Update a datasource","href":"/reference/knowledge-bases/update-a-datasource"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks","title":"List all chunks for a datasource","href":"/reference/knowledge-bases/list-all-chunks-for-a-datasource"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks","title":"Create chunks for a datasource","href":"/reference/knowledge-bases/create-chunks-for-a-datasource"},{"openapi":"delete /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks","title":"Delete multiple chunks","href":"/reference/knowledge-bases/delete-multiple-chunks"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/list","title":"List chunks with offset-based pagination","href":"/reference/knowledge-bases/list-chunks-with-offset-based-pagination"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/count","title":"Get chunks total count","href":"/reference/knowledge-bases/get-chunks-total-count"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}","title":"Retrieve a chunk","href":"/reference/knowledge-bases/retrieve-a-chunk"},{"openapi":"delete /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}","title":"Delete a chunk","href":"/reference/knowledge-bases/delete-a-chunk"},{"openapi":"patch /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}","title":"Update a chunk","href":"/reference/knowledge-bases/update-a-chunk"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources/preview-chunks","title":"Preview datasource chunks","href":"/reference/knowledge-bases/preview-datasource-chunks"},{"openapi":"patch /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}/enabled","title":"Set a chunk's enabled status","href":"/reference/knowledge-bases/set-a-chunks-enabled-status"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/datasource-processing-status","title":"Retrieve datasource processing status","href":"/reference/knowledge-bases/retrieve-datasource-processing-status"},{"openapi":"get /v2/knowledge/{knowledge_id}/upload-file","title":"Retrieve a file upload URL","href":"/reference/knowledge-bases/retrieve-a-file-upload-url"}]},{"group":"Logs","pages":[{"openapi":"post /v3/logs/aggregate","title":"Aggregate logs","href":"/reference/logs/aggregate-logs"},{"openapi":"post /v3/logs/facets","title":"List log facets","href":"/reference/logs/list-log-facets"},{"openapi":"get /v3/logs/facets/{field}","title":"List facet values","href":"/reference/logs/list-facet-values"},{"openapi":"get /v3/logs/fields","title":"List log fields","href":"/reference/logs/list-log-fields"},{"openapi":"post /v3/logs/patterns","title":"Find log patterns","href":"/reference/logs/find-log-patterns"},{"openapi":"post /v3/logs/query","title":"Query logs with OQL","href":"/reference/logs/query-logs-with-oql"},{"openapi":"post /v3/logs/search","title":"Search logs","href":"/reference/logs/search-logs"},{"openapi":"get /v3/logs/{id}","title":"Get a single log","href":"/reference/logs/get-a-single-log"},{"openapi":"post /v3/logs/{id}/context","title":"Get surrounding log context","href":"/reference/logs/get-surrounding-log-context"},{"openapi":"get /v3/traces/{trace_id}/logs","title":"List logs for a trace","href":"/reference/logs/list-logs-for-a-trace"}]},{"group":"MCP Gateways","pages":[{"openapi":"get /v2/mcp-gateways","title":"List MCP gateways","href":"/reference/mcp-gateway/list-mcp-gateways"},{"openapi":"post /v2/mcp-gateways","title":"Create an MCP gateway","href":"/reference/mcp-gateway/create-an-mcp-gateway"},{"openapi":"get /v2/mcp-gateways/{id}","title":"Retrieve an MCP gateway","href":"/reference/mcp-gateway/retrieve-an-mcp-gateway"},{"openapi":"delete /v2/mcp-gateways/{id}","title":"Delete an MCP gateway","href":"/reference/mcp-gateway/delete-an-mcp-gateway"},{"openapi":"patch /v2/mcp-gateways/{id}","title":"Update an MCP gateway","href":"/reference/mcp-gateway/update-an-mcp-gateway"},{"openapi":"get /v2/mcp-gateways/{gateway_id}/tools","title":"List exposed tools for a gateway","href":"/reference/mcp-gateway/list-exposed-tools-for-a-gateway"}]},{"group":"MCP Servers","pages":[{"openapi":"get /v2/mcp-servers","title":"List MCP servers","href":"/reference/mcp-gateway/list-mcp-servers"},{"openapi":"post /v2/mcp-servers","title":"Create an MCP server","href":"/reference/mcp-gateway/create-an-mcp-server"},{"openapi":"get /v2/mcp-servers/{id}","title":"Retrieve an MCP server","href":"/reference/mcp-gateway/retrieve-an-mcp-server"},{"openapi":"delete /v2/mcp-servers/{id}","title":"Delete an MCP server","href":"/reference/mcp-gateway/delete-an-mcp-server"},{"openapi":"patch /v2/mcp-servers/{id}","title":"Update an MCP server","href":"/reference/mcp-gateway/update-an-mcp-server"},{"openapi":"post /v2/mcp-servers/{id}:sync","title":"Sync an MCP server","href":"/reference/mcp-gateway/sync-an-mcp-server"},{"openapi":"post /v2/mcp-servers/{id}/tools:test","title":"Test an MCP server tool","href":"/reference/mcp-gateway/test-an-mcp-server-tool"}]},{"group":"Memory Stores","pages":[{"openapi":"get /v2/memory-stores","title":"List memory stores","href":"/reference/memory-stores/list-memory-stores"},{"openapi":"post /v2/memory-stores","title":"Create memory store","href":"/reference/memory-stores/create-memory-store"},{"openapi":"get /v2/memory-stores/{memory_store_key}","title":"Retrieve memory store","href":"/reference/memory-stores/retrieve-memory-store"},{"openapi":"delete /v2/memory-stores/{memory_store_key}","title":"Delete memory store","href":"/reference/memory-stores/delete-memory-store"},{"openapi":"patch /v2/memory-stores/{memory_store_key}","title":"Update memory store","href":"/reference/memory-stores/update-memory-store"},{"openapi":"get /v2/memory-stores/{memory_store_key}/memories","title":"List all memories","href":"/reference/memory-stores/list-all-memories"},{"openapi":"post /v2/memory-stores/{memory_store_key}/memories","title":"Create a new memory","href":"/reference/memory-stores/create-a-new-memory"},{"openapi":"get /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}","title":"Retrieve a specific memory","href":"/reference/memory-stores/retrieve-a-specific-memory"},{"openapi":"delete /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}","title":"Delete a specific memory","href":"/reference/memory-stores/delete-a-specific-memory"},{"openapi":"patch /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}","title":"Update a specific memory","href":"/reference/memory-stores/update-a-specific-memory"},{"openapi":"get /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents","title":"List all documents for a memory","href":"/reference/memory-stores/list-all-documents-for-a-memory"},{"openapi":"post /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents","title":"Create a new memory document","href":"/reference/memory-stores/create-a-new-memory-document"},{"openapi":"get /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents/{document_id}","title":"Retrieve a specific memory document","href":"/reference/memory-stores/retrieve-a-specific-memory-document"},{"openapi":"delete /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents/{document_id}","title":"Delete a specific memory document","href":"/reference/memory-stores/delete-a-specific-memory-document"},{"openapi":"patch /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents/{document_id}","title":"Update a specific memory document","href":"/reference/memory-stores/update-a-specific-memory-document"}]},{"group":"Model Catalog","pages":[{"openapi":"get /v2/model-catalog","sidebarTitle":"List catalog models","title":"List the model catalog","href":"/reference/model-catalog/list-the-model-catalog"},{"openapi":"get /v2/model-catalog/{model}/offerings","sidebarTitle":"List model offerings","title":"List model catalog offerings","href":"/reference/model-catalog/list-model-catalog-offerings"},{"openapi":"get /v2/model-catalog/{id}","sidebarTitle":"Get catalog entry","title":"Retrieve a model catalog entry","href":"/reference/model-catalog/retrieve-a-model-catalog-entry"}]},{"group":"Models","pages":[{"openapi":"get /v2/models","title":"List workspace models","href":"/reference/models/list-models"},{"openapi":"get /v3/router/models","title":"List router models","href":"/reference/models/list-router-models"},{"openapi":"post /v2/models","title":"Create custom model","href":"/reference/models/create-custom-model"},{"openapi":"post /v2/models/aws-bedrock","title":"Create AWS Bedrock custom model","href":"/reference/models/create-aws-bedrock-custom-model"},{"openapi":"post /v2/models/aws-bedrock/validate","title":"Validate AWS Bedrock inference profile","href":"/reference/models/validate-aws-bedrock-inference-profile"},{"openapi":"patch /v2/models/aws-bedrock/{id}","title":"Update AWS Bedrock custom model","href":"/reference/models/update-aws-bedrock-custom-model"},{"openapi":"post /v2/models/azure-foundry/deployments","title":"List Azure Foundry deployments under a resource","href":"/reference/models/list-azure-foundry-deployments-under-a-resource"},{"openapi":"post /v2/models/litellm/import","title":"Import models from LiteLLM","href":"/reference/models/import-models-from-litellm"},{"openapi":"get /v2/models/litellm/models","title":"List models from configured LiteLLM instance","href":"/reference/models/list-models-from-configured-litellm-instance"},{"openapi":"post /v2/models/openai-like","title":"Create OpenAI-compatible custom model","href":"/reference/models/create-openai-compatible-custom-model"},{"openapi":"patch /v2/models/openai-like/{id}","title":"Update OpenAI-compatible custom model","href":"/reference/models/update-openai-compatible-custom-model"},{"openapi":"post /v2/models/validate","title":"Validate model endpoint","href":"/reference/models/validate-model-endpoint"},{"openapi":"post /v2/models/vertex","title":"Create Vertex AI custom model","href":"/reference/models/create-vertex-ai-custom-model"},{"openapi":"delete /v2/models/{id}","title":"Delete custom model","href":"/reference/models/delete-custom-model"},{"openapi":"patch /v2/models/{id}","title":"Update custom model","href":"/reference/models/update-custom-model"}]},{"group":"Moderations","pages":[{"openapi":"post /v2/router/moderations","title":"Create moderation","href":"/reference/moderations/create-moderation"}]},{"group":"OCR","pages":[{"openapi":"post /v2/router/ocr","title":null,"href":"/reference/ocr/create-ocr"}]},{"group":"PII","pages":[{"openapi":"get /v2/pii/capabilities","title":"Get PII capabilities","href":"/reference/pii/get-pii-capabilities"},{"openapi":"post /v2/pii/detect","title":"Detect PII","href":"/reference/pii/detect-pii"},{"openapi":"post /v2/pii/redact","title":"Redact PII","href":"/reference/pii/redact-pii"},{"openapi":"post /v2/pii/restore","title":"Restore redacted text","href":"/reference/pii/restore-pii"}]},{"group":"Policies","pages":[{"openapi":"get /v2/policies","title":"List policies","href":"/reference/policies/list-policies"},{"openapi":"post /v2/policies","title":"Create policy","href":"/reference/policies/create-policy"},{"openapi":"get /v2/policies/{policy_id}","title":"Get policy","href":"/reference/policies/get-policy"},{"openapi":"delete /v2/policies/{policy_id}","title":"Delete policy","href":"/reference/policies/delete-policy"},{"openapi":"patch /v2/policies/{policy_id}","title":"Update policy","href":"/reference/policies/update-policy"}]},{"group":"Prompts","pages":[{"openapi":"get /v2/prompts","title":"List all prompts","href":"/reference/prompts/list-all-prompts"},{"openapi":"post /v2/prompts","title":"Create a prompt","description":"Create a new prompt in the workspace.","href":"/reference/prompts/create-a-prompt"},{"openapi":"get /v2/prompts/{id}","title":"Retrieve a prompt","href":"/reference/prompts/retrieve-a-prompt"},{"openapi":"delete /v2/prompts/{id}","title":"Delete a prompt","description":"Delete a prompt and all its versions by ID.","href":"/reference/prompts/delete-a-prompt"},{"openapi":"patch /v2/prompts/{id}","title":"Update a prompt","href":"/reference/prompts/update-a-prompt"},{"openapi":"get /v2/prompts/{prompt_id}/versions","title":"List all prompt versions","href":"/reference/prompts/list-all-prompt-versions"},{"openapi":"get /v2/prompts/{prompt_id}/versions/{version_id}","title":"Retrieve a prompt version","href":"/reference/prompts/retrieve-a-prompt-version"}]},{"group":"Reporting API","pages":[{"openapi":"post /v2/reporting","deprecated":true,"title":"Query reporting metrics","href":"/reference/reporting/query-reporting-metrics"}]},{"group":"Rerank","pages":[{"openapi":"post /v2/router/rerank","title":"Create rerank","href":"/reference/rerank/create-rerank"}]},{"group":"Responses","pages":[{"openapi":"post /v3/router/responses","title":"Create response","href":"/reference/responses/create-response"},{"openapi":"get /v3/router/responses/{response_id}","title":"Retrieve response","href":"/reference/responses/retrieve-response"}]},{"group":"Routing Rules","pages":[{"openapi":"get /v2/routing-rules","title":"List routing rules","href":"/reference/routing-rules/list-routing-rules"},{"openapi":"post /v2/routing-rules","title":"Create a routing rule","href":"/reference/routing-rules/create-routing-rule"},{"openapi":"get /v2/routing-rules/{routing_rule_id}","title":"Retrieve a routing rule","href":"/reference/routing-rules/get-routing-rule"},{"openapi":"delete /v2/routing-rules/{routing_rule_id}","title":"Delete a routing rule","href":"/reference/routing-rules/delete-routing-rule"},{"openapi":"patch /v2/routing-rules/{routing_rule_id}","title":"Update a routing rule","href":"/reference/routing-rules/update-routing-rule"},{"openapi":"get /v2/routing-rules/used-models","title":"List models used by routing rules","href":"/reference/routing-rules/list-used-models"}]},{"group":"Smart Routers","pages":[{"openapi":"get /v2/smart-routers","title":"List Smart Routers","href":"/reference/smart-routers/list-smart-routers"},{"openapi":"post /v2/smart-routers","title":"Create a Smart Router","href":"/reference/smart-routers/create-a-smart-router"},{"openapi":"get /v2/smart-routers/{smart_router_id}","title":"Retrieve a Smart Router","href":"/reference/smart-routers/retrieve-a-smart-router"},{"openapi":"delete /v2/smart-routers/{smart_router_id}","title":"Delete a Smart Router","href":"/reference/smart-routers/delete-a-smart-router"},{"openapi":"patch /v2/smart-routers/{smart_router_id}","title":"Update a Smart Router","href":"/reference/smart-routers/update-a-smart-router"}]},{"group":"Threads","pages":[{"openapi":"post /v2/sessions","title":"Create trace thread","href":"/reference/threads/create-trace-thread"},{"openapi":"post /v2/sessions/count","title":"Get thread count","href":"/reference/threads/get-thread-count"},{"openapi":"post /v2/sessions/query","title":"List trace threads","href":"/reference/threads/list-trace-threads"},{"openapi":"get /v2/sessions/tags","title":"List thread tags","href":"/reference/threads/list-thread-tags"},{"openapi":"get /v2/sessions/{session_id}","title":"Get trace thread","href":"/reference/threads/get-trace-thread"},{"openapi":"delete /v2/sessions/{session_id}","title":"Delete trace thread","href":"/reference/threads/delete-trace-thread"},{"openapi":"patch /v2/sessions/{session_id}","title":"Update trace thread","href":"/reference/threads/update-trace-thread"}]},{"group":"Skills","pages":[{"openapi":"get /v2/skills","title":"List all skills","href":"/reference/skills/list-all-skills"},{"openapi":"post /v2/skills","title":"Create a new skill","href":"/reference/skills/create-a-new-skill"},{"openapi":"get /v2/skills/{skill_id}","title":"Retrieve a skill","href":"/reference/skills/retrieve-a-skill"},{"openapi":"delete /v2/skills/{skill_id}","title":"Delete a skill","href":"/reference/skills/delete-a-skill"},{"openapi":"patch /v2/skills/{skill_id}","title":"Update a skill","href":"/reference/skills/update-a-skill"}]},{"group":"Tools","pages":[{"openapi":"get /v2/tools","title":"List tools","href":"/reference/tools/list-tools"},{"openapi":"post /v2/tools","title":"Create tool","href":"/reference/tools/create-tool"},{"openapi":"get /v2/tools/{tool_id}","title":"Retrieve tool","href":"/reference/tools/retrieve-tool"},{"openapi":"delete /v2/tools/{tool_id}","title":"Delete tool","href":"/reference/tools/delete-tool"},{"openapi":"patch /v2/tools/{tool_id}","title":"Update tool","href":"/reference/tools/update-tool"},{"openapi":"get /v2/tools/{tool_id}/versions","title":"List tool versions","href":"/reference/tools/list-tool-versions"},{"openapi":"get /v2/tools/{tool_id}/versions/{version_id}","title":"Get tool version","href":"/reference/tools/get-tool-version"}]},{"group":"Telemetry","pages":[{"openapi":"post /v3/telemetry/query","title":"Query telemetry","href":"/reference/telemetry/query-telemetry"},{"openapi":"get /v3/telemetry/capabilities","title":"List telemetry capabilities","href":"/reference/telemetry/list-telemetry-capabilities"},{"openapi":"post /v3/telemetry/facet-values","title":"List telemetry facet values","href":"/reference/telemetry/list-telemetry-facet-values"}]},{"group":"Traces","pages":[{"openapi":"post /v3/traces/aggregate","title":"Aggregate traces","href":"/reference/traces/aggregate-traces"},{"openapi":"post /v3/traces/search","title":"Search traces","href":"/reference/traces/search-traces"},{"openapi":"post /v3/traces/query","title":"Query traces with OQL","href":"/reference/traces/query-traces-with-oql"},{"openapi":"get /v3/traces/{trace_id}","title":"Get trace","href":"/reference/traces/get-trace"},{"openapi":"get /v3/traces/{trace_id}/spans","title":"List trace spans","href":"/reference/traces/list-trace-spans"},{"openapi":"get /v3/traces/{trace_id}/spans/{span_id}","title":"Get trace span","href":"/reference/traces/get-trace-span"},{"openapi":"get /v3/traces/{trace_id}/conversation","title":"Get trace conversation","href":"/reference/traces/get-trace-conversation"},{"openapi":"get /v3/traces/fields","title":"List trace fields","href":"/reference/traces/list-trace-fields"},{"openapi":"get /v3/traces/facets","title":"List trace facets","href":"/reference/traces/list-trace-facets"},{"openapi":"get /v3/traces/facets/{field}","title":"List trace facet values","href":"/reference/traces/list-trace-facet-values"}]},{"group":"Views","pages":[{"openapi":"post /v3/views","title":"Create a saved view","href":"/reference/views/create-a-saved-view"},{"openapi":"get /v3/views","title":"List visible saved views","href":"/reference/views/list-saved-views"},{"openapi":"get /v3/views/{view_id}","title":"Retrieve a saved view","href":"/reference/views/retrieve-a-saved-view"},{"openapi":"patch /v3/views/{view_id}","title":"Update a saved view","href":"/reference/views/update-a-saved-view"},{"openapi":"delete /v3/views/{view_id}","title":"Delete a saved view","href":"/reference/views/delete-a-saved-view"}]},{"group":"Webhooks","pages":[{"openapi":"get /v2/webhooks","title":"List webhooks","href":"/reference/webhooks/list-webhooks"},{"openapi":"get /v2/webhooks/secret","title":"Generate a webhook secret","href":"/reference/webhooks/generate-a-webhook-secret"},{"openapi":"post /v2/webhooks","title":"Create a webhook","href":"/reference/webhooks/create-a-webhook"},{"openapi":"get /v2/webhooks/count","title":"Count webhooks","href":"/reference/webhooks/count-webhooks"},{"openapi":"get /v2/webhooks/{id}","title":"Retrieve a webhook","href":"/reference/webhooks/retrieve-a-webhook"},{"openapi":"patch /v2/webhooks/{id}","title":"Update a webhook","href":"/reference/webhooks/update-a-webhook"},{"openapi":"delete /v2/webhooks/{id}","title":"Delete a webhook","href":"/reference/webhooks/delete-a-webhook"},{"openapi":"post /v2/webhooks/query","deprecated":true,"title":"Query webhooks","href":"/reference/webhooks/query-webhooks"}]}]},{"group":"Management APIs","pages":[{"title":"Management APIs","sidebarTitle":"Overview","href":"/management-apis/overview"},{"group":"API Keys","pages":[{"openapi":"get /v2/api-keys","title":"List API keys","href":"/reference/api-keys/list-api-keys"},{"openapi":"post /v2/api-keys","title":"Create a new API key","href":"/reference/api-keys/create-a-new-api-key"},{"openapi":"get /v2/api-keys/capabilities","title":"List capability catalog","href":"/reference/api-keys/list-capability-catalog"},{"openapi":"get /v2/api-keys/{api_key_id}","title":"Retrieve an API key","href":"/reference/api-keys/retrieve-an-api-key"},{"openapi":"delete /v2/api-keys/{api_key_id}","title":"Delete an API key","href":"/reference/api-keys/delete-an-api-key"},{"openapi":"patch /v2/api-keys/{api_key_id}","title":"Update an API key","href":"/reference/api-keys/update-an-api-key"}]},{"group":"Management Keys","pages":[{"openapi":"get /v2/management-keys","title":"List management keys","href":"/reference/management-keys/list-management-keys"},{"openapi":"post /v2/management-keys","title":"Create a new management key","href":"/reference/management-keys/create-a-new-management-key"},{"openapi":"get /v2/management-keys/capabilities","title":"List management capability catalog","href":"/reference/management-keys/list-management-capability-catalog"},{"openapi":"get /v2/management-keys/{management_key_id}","title":"Retrieve a management key","href":"/reference/management-keys/retrieve-a-management-key"},{"openapi":"delete /v2/management-keys/{management_key_id}","title":"Delete a management key","href":"/reference/management-keys/delete-a-management-key"},{"openapi":"patch /v2/management-keys/{management_key_id}","title":"Update a management key","href":"/reference/management-keys/update-a-management-key"}]},{"group":"Budgets","pages":[{"openapi":"get /v2/budgets","title":"List budgets","href":"/reference/budgets/list-budgets"},{"openapi":"post /v2/budgets","title":"Create a new budget","href":"/reference/budgets/create-a-new-budget"},{"openapi":"get /v2/budgets/{budget_id}","title":"Retrieve a budget","href":"/reference/budgets/retrieve-a-budget"},{"openapi":"delete /v2/budgets/{budget_id}","title":"Delete a budget","href":"/reference/budgets/delete-a-budget"},{"openapi":"patch /v2/budgets/{budget_id}","title":"Update a budget","href":"/reference/budgets/update-a-budget"},{"openapi":"post /v2/budgets/{budget_id}/reset-consumption","title":"Reset budget consumption","href":"/reference/budgets/reset-budget-consumption"}]},{"group":"Projects","pages":[{"openapi":"get /v2/projects","title":"List all projects","href":"/reference/projects/list-all-projects"},{"openapi":"post /v2/projects","title":"Create a new project","href":"/reference/projects/create-a-new-project"},{"openapi":"get /v2/projects/{project_id}","title":"Retrieve a project","href":"/reference/projects/retrieve-a-project"},{"openapi":"delete /v2/projects/{project_id}","title":"Delete a project","href":"/reference/projects/delete-a-project"},{"openapi":"patch /v2/projects/{project_id}","title":"Update a project","href":"/reference/projects/update-a-project"}]},{"group":"Alerts","pages":[{"openapi":"get /v2/alerts","title":"List alerts","href":"/reference/alerts/list-alerts"},{"openapi":"post /v2/alerts","title":"Create an alert","href":"/reference/alerts/create-an-alert"},{"openapi":"get /v2/alerts/{alert_id}","title":"Retrieve an alert","href":"/reference/alerts/retrieve-an-alert"},{"openapi":"delete /v2/alerts/{alert_id}","title":"Delete an alert","href":"/reference/alerts/delete-an-alert"},{"openapi":"patch /v2/alerts/{alert_id}","title":"Update an alert","href":"/reference/alerts/update-an-alert"},{"openapi":"get /v2/alerts/{alert_id}/triggers","title":"List alert triggers","href":"/reference/alerts/list-alert-triggers"},{"openapi":"get /v2/alerts/{alert_id}/triggers/{trigger_id}/events","title":"List alert trigger events","href":"/reference/alerts/list-alert-trigger-events"}]},{"group":"Notifiers","pages":[{"openapi":"get /v2/notifiers","title":"List notifiers","href":"/reference/notifiers/list-notifiers"},{"openapi":"post /v2/notifiers","title":"Create a notifier","href":"/reference/notifiers/create-a-notifier"},{"openapi":"get /v2/notifiers/{notifier_id}","title":"Retrieve a notifier","href":"/reference/notifiers/retrieve-a-notifier"},{"openapi":"delete /v2/notifiers/{notifier_id}","title":"Delete a notifier","href":"/reference/notifiers/delete-a-notifier"},{"openapi":"patch /v2/notifiers/{notifier_id}","title":"Update a notifier","href":"/reference/notifiers/update-a-notifier"}]},{"group":"Monitors","pages":[{"openapi":"get /v2/monitors","title":"List monitors","href":"/reference/monitors/list-monitors"},{"openapi":"post /v2/monitors","title":"Create a monitor","href":"/reference/monitors/create-a-monitor"},{"openapi":"get /v2/monitors/{monitor_id}","title":"Retrieve a monitor","href":"/reference/monitors/retrieve-a-monitor"},{"openapi":"delete /v2/monitors/{monitor_id}","title":"Delete a monitor","href":"/reference/monitors/delete-a-monitor"},{"openapi":"patch /v2/monitors/{monitor_id}","title":"Update a monitor","href":"/reference/monitors/update-a-monitor"},{"openapi":"get /v2/monitors/presets","title":"List monitor presets","href":"/reference/monitors/list-monitor-presets"}]},{"group":"Audit Logs","pages":[{"openapi":"post /v2/audit-logs/query","title":"Query audit logs","href":"/reference/audit-logs/query-audit-logs"}]},{"group":"Identities","pages":[{"openapi":"get /v2/identities","title":"List identities","href":"/reference/identities/list-identities"},{"openapi":"post /v2/identities","title":"Create an identity","href":"/reference/identities/create-an-identity"},{"openapi":"get /v2/identities/{id}","title":"Retrieve an identity","href":"/reference/identities/retrieve-an-identity"},{"openapi":"delete /v2/identities/{id}","title":"Delete an identity","href":"/reference/identities/delete-an-identity"},{"openapi":"patch /v2/identities/{id}","title":"Update an identity","href":"/reference/identities/update-an-identity"}]},{"group":"Workspaces","pages":[{"openapi":"get /v2/workspaces","title":"List workspaces","href":"/reference/workspaces/list-workspaces"},{"openapi":"get /v2/workspaces/{key}","title":"Retrieve a workspace","href":"/reference/workspaces/retrieve-a-workspace"},{"openapi":"patch /v2/workspaces/{key}","title":"Update a workspace","href":"/reference/workspaces/update-a-workspace"}]},{"group":"Users","pages":[{"openapi":"get /v3/users","title":"List workspace users","href":"/reference/users/list-workspace-users"},{"openapi":"post /v3/users/{id}","title":"Create or add workspace users","href":"/reference/users/create-or-add-workspace-users"},{"openapi":"get /v3/users/{id}","title":"Retrieve a workspace user","href":"/reference/users/retrieve-a-workspace-user"},{"openapi":"patch /v3/users/{id}","title":"Update a workspace user","href":"/reference/users/update-a-workspace-user"},{"openapi":"delete /v3/users/{id}","title":"Delete a workspace user","href":"/reference/users/delete-a-workspace-user"}]},{"group":"Workspace Settings","pages":[{"openapi":"get /v2/workspace-settings","title":"Retrieve workspace settings","href":"/reference/workspace-settings/retrieve-workspace-settings"},{"openapi":"patch /v2/workspace-settings","title":"Update workspace settings","href":"/reference/workspace-settings/update-workspace-settings"}]},{"group":"Workspace Security","pages":[{"openapi":"get /v2/workspaces/{workspace_key}/domains","title":"List verified domains","href":"/reference/workspace-security/list-verified-domains"},{"openapi":"post /v2/workspaces/{workspace_key}/domains","title":"Add a domain","href":"/reference/workspace-security/add-a-domain"},{"openapi":"delete /v2/workspaces/{workspace_key}/domains/{domain_id}","title":"Delete a domain","href":"/reference/workspace-security/delete-a-domain"},{"openapi":"post /v2/workspaces/{workspace_key}/domains/{domain_id}/verify","title":"Verify a domain","href":"/reference/workspace-security/verify-a-domain"},{"openapi":"get /v2/workspaces/{workspace_key}/ip-allowlist","title":"Retrieve the IP allowlist","href":"/reference/workspace-security/retrieve-the-ip-allowlist"},{"openapi":"patch /v2/workspaces/{workspace_key}/ip-allowlist","title":"Enable or disable the IP allowlist","href":"/reference/workspace-security/enable-or-disable-the-ip-allowlist"},{"openapi":"post /v2/workspaces/{workspace_key}/ip-allowlist/entries","title":"Add an IP range","href":"/reference/workspace-security/add-an-ip-range"},{"openapi":"delete /v2/workspaces/{workspace_key}/ip-allowlist/entries/{range_id}","title":"Delete an IP range","href":"/reference/workspace-security/delete-an-ip-range"}]},{"group":"Workspace Models","pages":[{"openapi":"post /v2/workspace-models","title":"Enable model for workspace","href":"/reference/models/enable-model-for-workspace"},{"openapi":"delete /v2/workspace-models/{model_id}","title":"Disable model for workspace","href":"/reference/models/disable-model-for-workspace"}]}]}]},{"tab":"Cookbooks","hidden":true,"pages":[{"title":"Cookbooks","href":"/ai-studio/cookbooks/cookbooks"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/release-4-17"}]}]},"basePath":"","title":"Retrieve a prompt - Orq.ai Documentation","buildId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","deploymentId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CVpqyvFO.js","utils-vpweLD0v.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BIOodqb0.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1LM3qmu.js","snippetPresets-C5xK0GtN.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CCsxLnQl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C2-WKG22.js","shallow-SdoLUC-q.js","getApiPlaygroundDisplay-BnI8L2hB.js","CodeSnippet-D5M8NCHI.js","CodeSnippets-CXRO8Uom.js","Page-CN9QbZiA.js","getPastedJson-CrfHEdRt.js","icon-Cr8AyUnW.js","MethodPill-J_Cs0kNw.js","DuplicateIcon-DrMboxGw.js","createIcon-B4CIWVbU.js","DynamicMarkdown-D9cdbgj9.js","SectionHeading-BO4CouT0.js","axios-vUo_bRtp.js","Markdown-L1m1-PSi.js","clsx-rIpTdK8h.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-ptfS1uB_.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D31Sm3f9.js"]}