(Developer message · object | System message · object | User message · object | Assistant message · object | Tool message · object | Function message · object)[]
required
A list of messages comprising the conversation so far. Depending on the
model you use, different message types (modalities) are
supported, like text,
images, and audio.
Minimum array length: 1
Developer-provided instructions that the model should follow, regardless of
messages sent by the user. With o1 models and newer, developer messages
replace the previous system messages.
Constrains effort on reasoning for
reasoning models.
Currently supported values are low, medium, and high. Reducing
reasoning effort can result in faster responses and fewer tokens used
on reasoning in a response.
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.
Modify the likelihood of specified tokens appearing in the completion.
Accepts a JSON object that maps tokens (specified by their token ID in the
tokenizer) to an associated bias value from -100 to 100. Mathematically,
the bias is added to the logits generated by the model prior to sampling.
The exact effect will vary per model, but values between -1 and 1 should
decrease or increase likelihood of selection; values like -100 or 100
should result in a ban or exclusive selection of the relevant token.
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.
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.
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.
Configuration for a Predicted Output,
which can greatly improve response times when large parts of the model
response are known ahead of time. This is most common when you are
regenerating a file with only minor changes to most of the content.
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.
An object specifying the format that the model must output.
Setting to { "type": "json_schema", "json_schema": {...} } enables
Structured Outputs which ensures the model will match your supplied JSON
schema. Learn more in the Structured Outputs
guide.
Setting to { "type": "json_object" } enables JSON mode, which ensures
the message the model generates is valid JSON.
Important: when using JSON mode, you must also instruct the model
to produce JSON yourself via a system or user message. Without this, the
model may generate an unending stream of whitespace until the generation
reaches the token limit, resulting in a long-running and seemingly "stuck"
request. Also note that the message content may be partially cut off if
finish_reason="length", which indicates the generation exceeded
max_tokens or the conversation exceeded the max context length.
This feature is in Beta.
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.
Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.
Required range: -9223372036854776000 <= x <= 9223372036854776000
Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:
If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.
If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.
If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.
When not set, the default behavior is 'auto'.
When this parameter is set, the response body will include the service_tier utilized.
If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Example Python code.
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.
We generally recommend altering this or top_p but not both.
An alternative to sampling with temperature, called nucleus sampling,
where the model considers the results of the tokens with top_p probability
mass. So 0.1 means only the tokens comprising the top 10% probability mass
are considered.
We generally recommend altering this or temperature but not both.
A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.
Controls which (if any) tool is called by the model.
none means the model will not call any tool and instead generates a message.
auto means the model can pick between generating a message or calling one or more tools.
required means the model must call one or more tools.
Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
none is the default when no tools are present. auto is the default if tools are present.
A list of functions the model may generate JSON inputs for.
Required array length: 1 - 128 elements
Show child attributes
Response
200 - application/json
Successful Response
Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Enkrypt AI","colors":{"primary":"#ff6b6b","light":"#ff8a80","dark":"#ee5a24"},"logo":{"light":"https://mintcdn.com/enkryptai-42/7kWxrBaXsO0YvXjU/logo/light-logo.png?fit=max\u0026auto=format\u0026n=7kWxrBaXsO0YvXjU\u0026q=85\u0026s=3e4d5072cef08dc6b8885a03a7821b72","dark":"https://mintcdn.com/enkryptai-42/7kWxrBaXsO0YvXjU/logo/dark-logo.png?fit=max\u0026auto=format\u0026n=7kWxrBaXsO0YvXjU\u0026q=85\u0026s=2134a9f8208236db09c1727430559527"},"favicon":"https://mintcdn.com/enkryptai-42/rjcjkOmgLVUKmbck/favicon.svg?fit=max\u0026auto=format\u0026n=rjcjkOmgLVUKmbck\u0026q=85\u0026s=89efba126b5f4577a46794f171d766f0","appearance":{"default":"light","strict":false},"background":{"decoration":"gradient","color":{"light":"#fff5f5","dark":"#1a0f0f"}},"navbar":{"links":[{"href":"https://app.enkryptai.com/login","label":"Login"},{"href":"https://www.enkryptai.com/request-a-demo","label":"Schedule Demo"}],"primary":{"type":"button","label":"Learn More","href":"https://enkryptai.com"}},"footer":{"socials":{"x":"https://x.com/enkryptai","linkedin":"https://www.linkedin.com/company/enkryptai","website":"https://enkryptai.com"}},"styling":{"codeblocks":"system","latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"enkryptai-42","hasAudioNarration":false,"actualSubdomain":"enkryptai-42","customDomains":["docs.enkryptai.com"],"gitSource":{"type":"github","owner":"enkryptai","repo":"sentry","deployBranch":"docs-wip","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae1c016d6a250fd1db8d8b2","collectionId":"3601b564-9eab-40b7-823e-550bf1c8b396","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae1c016d6a250fd1db8d8b2"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1c016d6a250fd1db8d8b2","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":340},{"language":"default","tag":"Get Started","count":65},{"language":"default","tag":"🗃️ Archived","count":48},{"language":"default","tag":"Get Started for Guardrails","count":39},{"language":"default","tag":"Examples","count":35},{"language":"default","tag":"🔴 Red Team API","count":30},{"language":"default","tag":"🛡️ Guardrails API Endpoints","count":24},{"language":"default","tag":"Red Team (Legacy)","count":22},{"language":"default","tag":"Guardrails Policy (Legacy)","count":11},{"language":"default","tag":"Get Started for Red Team","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/ai-proxy-api-reference/endpoint/chat-completions","slug":"/api-reference/ai-proxy-api-reference/endpoint/chat-completions","pageMetadata":{"openapi":"POST /ai-proxy/chat/completions","title":"AI Chat Completions Proxy Endpoint","description":null,"href":"/api-reference/ai-proxy-api-reference/endpoint/chat-completions"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"POST /ai-proxy/chat/completions","title":"AI Chat Completions Proxy Endpoint","description":null,"href":"/api-reference/ai-proxy-api-reference/endpoint/chat-completions"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"AI Chat Completions Proxy Endpoint","operationId":"ai_chat_completions_proxy_endpoint_post","tags":["AI Proxy"],"parameters":["b3a66b03-d7bc-4881-9233-0739e877e0d4","9aad3207-47d5-4e5d-9f32-6b3ab9f2d947","b8d9eace-6e3d-4924-9bd5-c04fa0fc9969"],"requestBody":"c82f84b4-f4b9-4cab-9cee-a8a39f78213d","responses":{"200":"2c312cad-2472-43f2-a91a-bbd91185e2ef"},"method":"post","type":"path","servers":["46d259d2-9225-46ce-aca1-4e05427371e5"],"security":["8565320a-4e60-418d-8700-2d1d509f0638"],"path":"/ai-proxy/chat/completions","baseUrlOptions":["https://api.enkryptai.com"],"title":"AI Chat Completions Proxy Endpoint","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b3a66b03-d7bc-4881-9233-0739e877e0d4":{"name":"X-Enkrypt-Deployment","in":"header","required":true,"schema":{"title":"Deployment Name","type":"string","description":"The deployment saved name. E.g. test-deployment-1","example":"test-deployment","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"9aad3207-47d5-4e5d-9f32-6b3ab9f2d947":{"name":"X-Enkrypt-Tags","in":"header","required":false,"schema":{"title":"Tags","type":"string","description":"Comma separated tags for the deployment if any","example":"openai-testing,unit-testing","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"b8d9eace-6e3d-4924-9bd5-c04fa0fc9969":{"name":"X-Enkrypt-Refresh-Cache","in":"header","required":false,"schema":{"title":"Refresh Cache","type":"boolean","description":"Refresh the cache if deployment, policy or model data is stale","example":false,"isRequired":false,"uniqueKey":"","typeLabel":"boolean"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"description":"A list of messages comprising the conversation so far. Depending on the\n[model](/docs/models) you use, different message types (modalities) are\nsupported, like [text](/docs/guides/text-generation),\n[images](/docs/guides/vision), and [audio](/docs/guides/audio).\n","type":"array","minItems":1,"items":{"oneOf":[{"type":"object","title":"Developer message","description":"Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages.\n","required":["content","role"],"x-oaiExpandable":true,"properties":{"content":{"oneOf":[{"type":"string","title":"Text content","description":"The contents of the developer message.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","title":"Text content part","description":"Learn about [text inputs](/docs/guides/text-generation).\n","properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].text","typeLabel":"string"}},"required":["type","text"],"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object"},"title":"Array of content parts","description":"The contents of the developer message.","minItems":1,"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1","typeLabel":"Text content part · object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content","typeLabel":"string | Text content part · object[]"},"role":{"type":"string","enum":["developer"],"description":"The role of the messages author, in this case `developer`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.role","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role.","uniqueKey":"messages.items.[INDEX].oneOf.0.name","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.0","typeLabel":"Developer message · object"},{"type":"object","title":"System message","description":"Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead.\n","required":["content","role"],"x-oaiExpandable":true,"properties":{"content":{"oneOf":[{"type":"string","title":"Text content","description":"The contents of the system message.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","title":"Text content part","description":"Learn about [text inputs](/docs/guides/text-generation).\n","required":["type","text"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].text","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object"},"title":"Array of content parts","description":"The contents of the system message.","minItems":1,"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1","typeLabel":"Text content part · object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content","typeLabel":"string | Text content part · object[]"},"role":{"type":"string","enum":["system"],"description":"The role of the messages author, in this case `system`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role.","uniqueKey":"messages.items.[INDEX].oneOf.1.name","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.1","typeLabel":"System message · object"},{"type":"object","title":"User message","description":"Messages sent by an end user, containing prompts or additional context\ninformation.\n","required":["content","role"],"x-oaiExpandable":true,"properties":{"content":{"oneOf":[{"type":"string","title":"Text content","description":"The contents of the user message.\n","x-oaiExpandable":true,"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","title":"Text content part","description":"Learn about [text inputs](/docs/guides/text-generation).\n","required":["type","text"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"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":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"Text content part · object"},{"type":"object","title":"Image content part","description":"Learn about [image inputs](/docs/guides/vision).\n","required":["type","image_url"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["image_url"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.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.","format":"uri","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.image_url.url","typeLabel":"string\u003curi>"},"detail":{"type":"string","description":"Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision#low-or-high-fidelity-image-understanding).","enum":["auto","low","high"],"default":"auto","uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.image_url.detail","typeLabel":"enum\u003cstring>"}},"required":["url"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1.image_url","typeLabel":"object"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"Image content part · object"},{"type":"object","title":"Audio content part","description":"Learn about [audio inputs](/docs/guides/audio).\n","required":["type","input_audio"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["input_audio"],"description":"The type of the content part. Always `input_audio`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.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":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.input_audio.data","typeLabel":"string"},"format":{"type":"string","enum":["wav","mp3"],"description":"The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".\n","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.input_audio.format","typeLabel":"enum\u003cstring>"}},"required":["data","format"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2.input_audio","typeLabel":"object"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"Audio content part · object"}],"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object | Image content part · object | Audio content part · object"},"title":"Array of content parts","description":"The contents of the user message.\n","minItems":1,"x-oaiExpandable":true,"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1","typeLabel":"(Text content part · object | Image content part · object | Audio content part · object)[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content","typeLabel":"string | (Text content part · object | Image content part · object | Audio content part · object)[]"},"role":{"type":"string","enum":["user"],"description":"The role of the messages author, in this case `user`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.role","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"An optional name for the participant. Provides the model information to differentiate between participants of the same role.","uniqueKey":"messages.items.[INDEX].oneOf.2.name","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.2","typeLabel":"User message · object"},{"type":"object","title":"Assistant message","description":"Messages sent by the model in response to user messages.\n","required":["role"],"x-oaiExpandable":true,"properties":{"role":{"type":"string","enum":["assistant"],"description":"The role of the messages author, in this case `assistant`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","title":"Text content","description":"The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n","x-oaiExpandable":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","title":"Text content part","description":"Learn about [text inputs](/docs/guides/text-generation).\n","required":["type","text"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"Text content part · object"},{"type":"object","title":"Refusal content part","required":["type","refusal"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"refusal":{"type":"string","description":"The refusal message generated by the model.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.1.refusal","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"Refusal content part · object"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object | Refusal content part · object"},"title":"Array of content parts","description":"The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n","minItems":1,"x-oaiExpandable":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1","typeLabel":"(Text content part · object | Refusal content part · object)[]"},{"type":"null","uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.2","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.content","typeLabel":"string | (Text content part · object | Refusal content part · object)[] | null"},"refusal":{"oneOf":[{"type":"string","description":"The refusal message by the assistant.","uniqueKey":"messages.items.[INDEX].oneOf.3.refusal.oneOf.0","typeLabel":"string"},{"type":"null","description":"The refusal message by the assistant.","uniqueKey":"messages.items.[INDEX].oneOf.3.refusal.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.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":"messages.items.[INDEX].oneOf.3.name","typeLabel":"string"},"audio":{"oneOf":[{"type":"object","x-oaiExpandable":true,"description":"Data about a previous audio response from the model. \n[Learn more](/docs/guides/audio).\n","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a previous audio response from the model.\n","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.audio.oneOf.0.id","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.audio.oneOf.0","typeLabel":"object"},{"type":"null","x-oaiExpandable":true,"description":"Data about a previous audio response from the model. \n[Learn more](/docs/guides/audio).\n","required":["id"],"properties":{"id":{"type":"string","description":"Unique identifier for a previous audio response from the model.\n"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.audio.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.audio","typeLabel":"object | null"},"tool_calls":{"type":"array","description":"The tool calls generated by the model, such as function calls.","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the tool call.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.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":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","description":"The function that the model called.","properties":{"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.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.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].function.arguments","typeLabel":"string"}},"required":["name","arguments"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].function","typeLabel":"object"}},"required":["id","type","function"],"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls","typeLabel":"object[]"},"function_call":{"oneOf":[{"type":"object","deprecated":true,"description":"Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.","properties":{"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.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call.oneOf.0.arguments","typeLabel":"string"},"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call.oneOf.0.name","typeLabel":"string"}},"required":["arguments","name"],"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call.oneOf.0","typeLabel":"object"},{"type":"null","deprecated":true,"description":"Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.","properties":{"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."},"name":{"type":"string","description":"The name of the function to call."}},"required":["arguments","name"],"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.function_call","typeLabel":"object | null"}},"uniqueKey":"messages.items.[INDEX].oneOf.3","typeLabel":"Assistant message · object"},{"type":"object","title":"Tool message","required":["role","content","tool_call_id"],"x-oaiExpandable":true,"properties":{"role":{"type":"string","enum":["tool"],"description":"The role of the messages author, in this case `tool`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","title":"Text content","description":"The contents of the tool message.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","title":"Text content part","description":"Learn about [text inputs](/docs/guides/text-generation).\n","required":["type","text"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.1.items.[INDEX].text","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object"},"title":"Array of content parts","description":"The contents of the tool message.","minItems":1,"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content.oneOf.1","typeLabel":"Text content part · object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content","typeLabel":"string | Text content part · object[]"},"tool_call_id":{"type":"string","description":"Tool call that this message is responding to.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.tool_call_id","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.4","typeLabel":"Tool message · object"},{"type":"object","title":"Function message","required":["role","content","name"],"deprecated":true,"x-oaiExpandable":true,"properties":{"role":{"type":"string","enum":["function"],"description":"The role of the messages author, in this case `function`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The contents of the function message.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.content.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contents of the function message.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.content","typeLabel":"string | null"},"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.5.name","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.5","typeLabel":"Function message · object"}],"uniqueKey":"messages.items.[INDEX]","typeLabel":"Developer message · object | System message · object | User message · object | Assistant message · object | Tool message · object | Function message · object"},"isRequired":true,"uniqueKey":"messages","typeLabel":"(Developer message · object | System message · object | User message · object | Assistant message · object | Tool message · object | Function message · object)[]"},"enkrypt_context":{"type":"string","description":"The context for the request if using relevancy or hallucion detection in output guardrails","uniqueKey":"enkrypt_context","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"ID of the model to use. See the [model endpoint compatibility](/docs/models#model-endpoint-compatibility) table for details on which models work with the Chat API.","x-oaiTypeLabel":"string","example":"gpt-4o","uniqueKey":"model.oneOf.0","typeLabel":"string"},{"type":"string","description":"ID of the model to use. See the [model endpoint compatibility](/docs/models#model-endpoint-compatibility) table for details on which models work with the Chat API.","enum":["o1","o1-2024-12-17","o1-preview","o1-preview-2024-09-12","o1-mini","o1-mini-2024-09-12","gpt-4o","gpt-4o-2024-11-20","gpt-4o-2024-08-06","gpt-4o-2024-05-13","gpt-4o-audio-preview","gpt-4o-audio-preview-2024-10-01","gpt-4o-audio-preview-2024-12-17","gpt-4o-mini-audio-preview","gpt-4o-mini-audio-preview-2024-12-17","chatgpt-4o-latest","gpt-4o-mini","gpt-4o-mini-2024-07-18","gpt-4-turbo","gpt-4-turbo-2024-04-09","gpt-4-0125-preview","gpt-4-turbo-preview","gpt-4-1106-preview","gpt-4-vision-preview","gpt-4","gpt-4-0314","gpt-4-0613","gpt-4-32k","gpt-4-32k-0314","gpt-4-32k-0613","gpt-3.5-turbo","gpt-3.5-turbo-16k","gpt-3.5-turbo-0301","gpt-3.5-turbo-0613","gpt-3.5-turbo-1106","gpt-3.5-turbo-0125","gpt-3.5-turbo-16k-0613"],"x-oaiTypeLabel":"string","example":"gpt-4o","uniqueKey":"model.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"model","typeLabel":"string | enum\u003cstring>"},"store":{"oneOf":[{"type":"boolean","default":false,"description":"Whether or not to store the output of this chat completion request for \nuse in our [model distillation](/docs/guides/distillation) or\n[evals](/docs/guides/evals) products.\n","uniqueKey":"store.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"Whether or not to store the output of this chat completion request for \nuse in our [model distillation](/docs/guides/distillation) or\n[evals](/docs/guides/evals) products.\n","uniqueKey":"store.oneOf.1","typeLabel":"null"}],"uniqueKey":"store","typeLabel":"boolean | null"},"reasoning_effort":{"type":"string","enum":["low","medium","high"],"default":"medium","description":"**o1 models only** \n\nConstrains effort on reasoning for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n","uniqueKey":"reasoning_effort","typeLabel":"enum\u003cstring>"},"metadata":{"oneOf":[{"type":"object","description":"Developer-defined tags and values used for filtering completions\nin the [dashboard](https://platform.openai.com/chat-completions).\n","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Developer-defined tags and values used for filtering completions\nin the [dashboard](https://platform.openai.com/chat-completions).\n","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"frequency_penalty":{"oneOf":[{"type":"number","default":0,"minimum":-2,"maximum":2,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on\ntheir existing frequency in the text so far, decreasing the model's\nlikelihood to repeat the same line verbatim.\n","uniqueKey":"frequency_penalty.oneOf.0","typeLabel":"number"},{"type":"null","default":0,"minimum":-2,"maximum":2,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on\ntheir existing frequency in the text so far, decreasing the model's\nlikelihood to repeat the same line verbatim.\n","uniqueKey":"frequency_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"frequency_penalty","typeLabel":"number | null"},"logit_bias":{"oneOf":[{"type":"object","x-oaiTypeLabel":"map","default":null,"additionalProperties":{"type":"integer","uniqueKey":"logit_bias.oneOf.0.additionalProperties","typeLabel":"integer"},"description":"Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the\ntokenizer) to an associated bias value from -100 to 100. Mathematically,\nthe bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should\ndecrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.\n","uniqueKey":"logit_bias.oneOf.0","typeLabel":"object"},{"type":"null","x-oaiTypeLabel":"map","default":null,"additionalProperties":{"type":"integer","uniqueKey":"logit_bias.oneOf.1.additionalProperties","typeLabel":"integer"},"description":"Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the\ntokenizer) to an associated bias value from -100 to 100. Mathematically,\nthe bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should\ndecrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.\n","uniqueKey":"logit_bias.oneOf.1","typeLabel":"null"}],"uniqueKey":"logit_bias","typeLabel":"object | null"},"logprobs":{"oneOf":[{"description":"Whether to return log probabilities of the output tokens or not. If true,\nreturns the log probabilities of each output token returned in the\n`content` of `message`.\n","type":"boolean","default":false,"uniqueKey":"logprobs.oneOf.0","typeLabel":"boolean"},{"description":"Whether to return log probabilities of the output tokens or not. If true,\nreturns the log probabilities of each output token returned in the\n`content` of `message`.\n","type":"null","default":false,"uniqueKey":"logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"logprobs","typeLabel":"boolean | null"},"top_logprobs":{"oneOf":[{"description":"An integer between 0 and 20 specifying the number of most likely tokens to\nreturn at each token position, each with an associated log probability.\n`logprobs` must be set to `true` if this parameter is used.\n","type":"integer","minimum":0,"maximum":20,"uniqueKey":"top_logprobs.oneOf.0","typeLabel":"integer"},{"description":"An integer between 0 and 20 specifying the number of most likely tokens to\nreturn at each token position, each with an associated log probability.\n`logprobs` must be set to `true` if this parameter is used.\n","type":"null","minimum":0,"maximum":20,"uniqueKey":"top_logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_logprobs","typeLabel":"integer | null"},"max_tokens":{"oneOf":[{"description":"The maximum number of [tokens](/tokenizer) that can be generated in the\nchat completion. This value can be used to control\n[costs](https://openai.com/api/pricing/) for text generated via API.\n\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o1 series models](/docs/guides/reasoning).\n","type":"integer","deprecated":true,"uniqueKey":"max_tokens.oneOf.0","typeLabel":"integer"},{"description":"The maximum number of [tokens](/tokenizer) that can be generated in the\nchat completion. This value can be used to control\n[costs](https://openai.com/api/pricing/) for text generated via API.\n\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o1 series models](/docs/guides/reasoning).\n","type":"null","deprecated":true,"uniqueKey":"max_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_tokens","typeLabel":"integer | null"},"max_completion_tokens":{"oneOf":[{"description":"An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n","type":"integer","uniqueKey":"max_completion_tokens.oneOf.0","typeLabel":"integer"},{"description":"An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n","type":"null","uniqueKey":"max_completion_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_completion_tokens","typeLabel":"integer | null"},"n":{"oneOf":[{"type":"integer","minimum":1,"maximum":128,"default":1,"example":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":"n.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":128,"default":1,"example":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":"n.oneOf.1","typeLabel":"null"}],"uniqueKey":"n","typeLabel":"integer | null"},"modalities":{"oneOf":[{"type":"array","description":"Output types that you would like the model to generate for this request.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to [generate audio](/docs/guides/audio). To\nrequest that this model generate both text and audio responses, you can\nuse:\n\n`[\"text\", \"audio\"]`\n","items":{"type":"string","enum":["text","audio"],"uniqueKey":"modalities.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"modalities.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","description":"Output types that you would like the model to generate for this request.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to [generate audio](/docs/guides/audio). To\nrequest that this model generate both text and audio responses, you can\nuse:\n\n`[\"text\", \"audio\"]`\n","items":{"type":"string","enum":["text","audio"]},"uniqueKey":"modalities.oneOf.1","typeLabel":"null"}],"uniqueKey":"modalities","typeLabel":"enum\u003cstring>[] | null"},"prediction":{"oneOf":[{"type":"object","title":"Static Content","description":"Configuration for a [Predicted Output](/docs/guides/predicted-outputs),\nwhich can greatly improve response times when large parts of the model\nresponse are known ahead of time. This is most common when you are\nregenerating a file with only minor changes to most of the content.\n","required":["type","content"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["content"],"description":"The type of the predicted content you want to provide. This type is\ncurrently always `content`.\n","isRequired":true,"uniqueKey":"prediction.oneOf.0.type","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","title":"Text content","description":"The content that should be matched when generating a model response.\nIf generated tokens would match this content, the entire model response\ncan be returned much more quickly.\n","x-oaiExpandable":true,"isRequired":true,"uniqueKey":"prediction.oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","title":"Text content part","description":"Learn about [text inputs](/docs/guides/text-generation).\n","properties":{"type":{"type":"string","enum":["text"],"description":"The type of the content part.","isRequired":true,"uniqueKey":"prediction.oneOf.0.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content.","isRequired":true,"uniqueKey":"prediction.oneOf.0.content.oneOf.1.items.[INDEX].text","typeLabel":"string"}},"required":["type","text"],"uniqueKey":"prediction.oneOf.0.content.oneOf.1.items.[INDEX]","typeLabel":"Text content part · object"},"title":"Array of content parts","description":"The content that should be matched when generating a model response.\nIf generated tokens would match this content, the entire model response\ncan be returned much more quickly.\n","minItems":1,"x-oaiExpandable":true,"isRequired":true,"uniqueKey":"prediction.oneOf.0.content.oneOf.1","typeLabel":"Text content part · object[]"}],"isRequired":true,"uniqueKey":"prediction.oneOf.0.content","typeLabel":"string | Text content part · object[]"}},"uniqueKey":"prediction.oneOf.0","typeLabel":"Static Content · object"},{"type":"null","uniqueKey":"prediction.oneOf.1","typeLabel":"null"}],"uniqueKey":"prediction","typeLabel":"Static Content · object | null"},"audio":{"oneOf":[{"type":"object","description":"Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](/docs/guides/audio).\n","required":["voice","format"],"x-oaiExpandable":true,"properties":{"voice":{"type":"string","enum":["alloy","ash","ballad","coral","echo","sage","shimmer","verse"],"description":"The voice the model uses to respond. Supported voices are `ash`, `ballad`, `coral`, `sage`, and `verse` (also supported but not recommended are `alloy`, `echo`, and `shimmer`; these voices are less expressive).\n","isRequired":true,"uniqueKey":"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`,\n`opus`, or `pcm16`.\n","isRequired":true,"uniqueKey":"audio.oneOf.0.format","typeLabel":"enum\u003cstring>"}},"uniqueKey":"audio.oneOf.0","typeLabel":"object"},{"type":"null","description":"Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](/docs/guides/audio).\n","required":["voice","format"],"x-oaiExpandable":true,"properties":{"voice":{"type":"string","enum":["alloy","ash","ballad","coral","echo","sage","shimmer","verse"],"description":"The voice the model uses to respond. Supported voices are `ash`, `ballad`, `coral`, `sage`, and `verse` (also supported but not recommended are `alloy`, `echo`, and `shimmer`; these voices are less expressive).\n"},"format":{"type":"string","enum":["wav","mp3","flac","opus","pcm16"],"description":"Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,\n`opus`, or `pcm16`.\n"}},"uniqueKey":"audio.oneOf.1","typeLabel":"null"}],"uniqueKey":"audio","typeLabel":"object | null"},"presence_penalty":{"oneOf":[{"type":"number","default":0,"minimum":-2,"maximum":2,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on\nwhether they appear in the text so far, increasing the model's likelihood\nto talk about new topics.\n","uniqueKey":"presence_penalty.oneOf.0","typeLabel":"number"},{"type":"null","default":0,"minimum":-2,"maximum":2,"description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on\nwhether they appear in the text so far, increasing the model's likelihood\nto talk about new topics.\n","uniqueKey":"presence_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"presence_penalty","typeLabel":"number | null"},"response_format":{"oneOf":[{"type":"object","description":"An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures\nthe message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model\nto produce JSON yourself via a system or user message. Without this, the\nmodel may generate an unending stream of whitespace until the generation\nreaches the token limit, resulting in a long-running and seemingly \"stuck\"\nrequest. Also note that the message content may be partially cut off if\n`finish_reason=\"length\"`, which indicates the generation exceeded\n`max_tokens` or the conversation exceeded the max context length.\n","required":["type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of response format being defined: `text`","enum":["text"],"isRequired":true,"uniqueKey":"response_format.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"response_format.oneOf.0","typeLabel":"object"},{"type":"object","description":"An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures\nthe message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model\nto produce JSON yourself via a system or user message. Without this, the\nmodel may generate an unending stream of whitespace until the generation\nreaches the token limit, resulting in a long-running and seemingly \"stuck\"\nrequest. Also note that the message content may be partially cut off if\n`finish_reason=\"length\"`, which indicates the generation exceeded\n`max_tokens` or the conversation exceeded the max context length.\n","required":["type"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of response format being defined: `json_object`","enum":["json_object"],"isRequired":true,"uniqueKey":"response_format.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"response_format.oneOf.1","typeLabel":"object"},{"type":"object","description":"An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures\nthe message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model\nto produce JSON yourself via a system or user message. Without this, the\nmodel may generate an unending stream of whitespace until the generation\nreaches the token limit, resulting in a long-running and seemingly \"stuck\"\nrequest. Also note that the message content may be partially cut off if\n`finish_reason=\"length\"`, which indicates the generation exceeded\n`max_tokens` or the conversation exceeded the max context length.\n","required":["type","json_schema"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","description":"The type of response format being defined: `json_schema`","enum":["json_schema"],"isRequired":true,"uniqueKey":"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":"response_format.oneOf.2.json_schema.name","typeLabel":"string"},"description":{"type":"string","description":"A description of what the response format is for, used by the model to determine how to respond in the format.","uniqueKey":"response_format.oneOf.2.json_schema.description","typeLabel":"string"},"schema":{"type":"object","description":"The schema for the response format, described as a JSON Schema object.","additionalProperties":true,"uniqueKey":"response_format.oneOf.2.json_schema.schema","typeLabel":"object"},"strict":{"oneOf":[{"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`. To learn more, read the [Structured Outputs guide](/docs/guides/structured-outputs).","uniqueKey":"response_format.oneOf.2.json_schema.strict.oneOf.0","typeLabel":"boolean"},{"type":"null","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`. To learn more, read the [Structured Outputs guide](/docs/guides/structured-outputs).","uniqueKey":"response_format.oneOf.2.json_schema.strict.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_format.oneOf.2.json_schema.strict","typeLabel":"boolean | null"}},"required":["type","name"],"isRequired":true,"uniqueKey":"response_format.oneOf.2.json_schema","typeLabel":"object"}},"uniqueKey":"response_format.oneOf.2","typeLabel":"object"}],"uniqueKey":"response_format","typeLabel":"object"},"seed":{"oneOf":[{"type":"integer","minimum":-9223372036854776000,"maximum":9223372036854776000,"description":"This feature is in Beta.\nIf 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.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n","x-oaiMeta":{"beta":true},"uniqueKey":"seed.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":-9223372036854776000,"maximum":9223372036854776000,"description":"This feature is in Beta.\nIf 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.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n","x-oaiMeta":{"beta":true},"uniqueKey":"seed.oneOf.1","typeLabel":"null"}],"uniqueKey":"seed","typeLabel":"integer | null"},"service_tier":{"oneOf":[{"description":"Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:\n - If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.\n - If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.\n - If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.\n - When not set, the default behavior is 'auto'.\n\n When this parameter is set, the response body will include the `service_tier` utilized.\n","type":"string","enum":["auto","default"],"default":"auto","uniqueKey":"service_tier.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:\n - If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.\n - If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.\n - If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.\n - When not set, the default behavior is 'auto'.\n\n When this parameter is set, the response body will include the `service_tier` utilized.\n","type":"null","enum":["auto","default"],"default":"auto","uniqueKey":"service_tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"service_tier","typeLabel":"enum\u003cstring> | null"},"stop":{"oneOf":[{"type":"string","description":"Up to 4 sequences where the API will stop generating further tokens.\n","uniqueKey":"stop.oneOf.0","typeLabel":"string"},{"type":"null","description":"Up to 4 sequences where the API will stop generating further tokens.\n","uniqueKey":"stop.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"stop.oneOf.2.items.[INDEX]","typeLabel":"string"},"description":"Up to 4 sequences where the API will stop generating further tokens.\n","maxItems":4,"minItems":1,"uniqueKey":"stop.oneOf.2","typeLabel":"string[]"}],"uniqueKey":"stop","typeLabel":"string | null | string[]"},"stream":{"oneOf":[{"description":"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n","type":"boolean","default":false,"uniqueKey":"stream.oneOf.0","typeLabel":"boolean"},{"description":"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n","type":"null","default":false,"uniqueKey":"stream.oneOf.1","typeLabel":"null"}],"uniqueKey":"stream","typeLabel":"boolean | null"},"stream_options":{"oneOf":[{"description":"Options for streaming response. Only set this when you set `stream: true`.\n","type":"object","default":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.\n","uniqueKey":"stream_options.oneOf.0.include_usage","typeLabel":"boolean"}},"uniqueKey":"stream_options.oneOf.0","typeLabel":"object"},{"description":"Options for streaming response. Only set this when you set `stream: true`.\n","type":"null","default":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.\n"}},"uniqueKey":"stream_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"stream_options","typeLabel":"object | null"},"temperature":{"oneOf":[{"type":"number","minimum":0,"maximum":2,"default":1,"example":1,"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.\nWe generally recommend altering this or `top_p` but not both.\n","uniqueKey":"temperature.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":2,"default":1,"example":1,"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.\nWe generally recommend altering this or `top_p` but not both.\n","uniqueKey":"temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"temperature","typeLabel":"number | null"},"top_p":{"oneOf":[{"type":"number","minimum":0,"maximum":1,"default":1,"example":1,"description":"An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.\n","uniqueKey":"top_p.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":1,"default":1,"example":1,"description":"An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.\n","uniqueKey":"top_p.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_p","typeLabel":"number | null"},"tools":{"type":"array","description":"A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.\n","items":{"type":"object","properties":{"type":{"type":"string","enum":["function"],"description":"The type of the tool. Currently, only `function` is supported.","isRequired":true,"uniqueKey":"tools.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","properties":{"name":{"type":"string","description":"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","isRequired":true,"uniqueKey":"tools.items.[INDEX].function.name","typeLabel":"string"},"description":{"type":"string","description":"A description of what the function does, used by the model to choose when and how to call the function.","uniqueKey":"tools.items.[INDEX].function.description","typeLabel":"string"},"parameters":{"type":"object","description":"The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.","additionalProperties":true,"uniqueKey":"tools.items.[INDEX].function.parameters","typeLabel":"object"},"strict":{"oneOf":[{"type":"boolean","default":false,"description":"Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling).","uniqueKey":"tools.items.[INDEX].function.strict.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling).","uniqueKey":"tools.items.[INDEX].function.strict.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.items.[INDEX].function.strict","typeLabel":"boolean | null"}},"required":["name"],"isRequired":true,"uniqueKey":"tools.items.[INDEX].function","typeLabel":"object"}},"required":["type","function"],"uniqueKey":"tools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tools","typeLabel":"object[]"},"tool_choice":{"oneOf":[{"type":"string","description":"Controls which (if any) tool is called by the model.\n`none` means the model will not call any tool and instead generates a message.\n`auto` means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools.\nSpecifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n\n`none` is the default when no tools are present. `auto` is the default if tools are present.\n","enum":["none","auto","required"],"x-oaiExpandable":true,"uniqueKey":"tool_choice.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Controls which (if any) tool is called by the model.\n`none` means the model will not call any tool and instead generates a message.\n`auto` means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools.\nSpecifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n\n`none` is the default when no tools are present. `auto` is the default if tools are present.\n","required":["type","function"],"x-oaiExpandable":true,"properties":{"type":{"type":"string","enum":["function"],"description":"The type of the tool. Currently, only `function` is supported.","isRequired":true,"uniqueKey":"tool_choice.oneOf.1.type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","properties":{"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"tool_choice.oneOf.1.function.name","typeLabel":"string"}},"required":["name"],"isRequired":true,"uniqueKey":"tool_choice.oneOf.1.function","typeLabel":"object"}},"uniqueKey":"tool_choice.oneOf.1","typeLabel":"object"}],"uniqueKey":"tool_choice","typeLabel":"enum\u003cstring> | object"},"parallel_tool_calls":{"description":"Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.","type":"boolean","default":true,"uniqueKey":"parallel_tool_calls","typeLabel":"boolean"},"user":{"type":"string","example":"user-1234","description":"A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n","uniqueKey":"user","typeLabel":"string"},"function_call":{"oneOf":[{"type":"string","description":"Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n\n`none` means the model will not call a function and instead generates a\nmessage.\n\n`auto` means the model can pick between generating a message or calling a\nfunction.\n\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the\nmodel to call that function.\n\n`none` is the default when no functions are present. `auto` is the default\nif functions are present.\n","enum":["none","auto"],"deprecated":true,"x-oaiExpandable":true,"uniqueKey":"function_call.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n\n`none` means the model will not call a function and instead generates a\nmessage.\n\n`auto` means the model can pick between generating a message or calling a\nfunction.\n\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the\nmodel to call that function.\n\n`none` is the default when no functions are present. `auto` is the default\nif functions are present.\n","required":["name"],"deprecated":true,"x-oaiExpandable":true,"properties":{"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"function_call.oneOf.1.name","typeLabel":"string"}},"uniqueKey":"function_call.oneOf.1","typeLabel":"object"}],"uniqueKey":"function_call","typeLabel":"enum\u003cstring> | object"},"functions":{"deprecated":true,"description":"Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.\n","type":"array","minItems":1,"maxItems":128,"items":{"type":"object","deprecated":true,"properties":{"name":{"type":"string","description":"The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.","isRequired":true,"uniqueKey":"functions.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"A description of what the function does, used by the model to choose when and how to call the function.","uniqueKey":"functions.items.[INDEX].description","typeLabel":"string"},"parameters":{"type":"object","description":"The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.","additionalProperties":true,"uniqueKey":"functions.items.[INDEX].parameters","typeLabel":"object"}},"required":["name"],"uniqueKey":"functions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"functions","typeLabel":"object[]"}},"required":["messages"],"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","value":{"messages":[{"role":"user","content":"hi"}]}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"2c312cad-2472-43f2-a91a-bbd91185e2ef":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"EnkryptCreateChatCompletionResponse","description":"Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).\n","required":["id","object","created","model","choices"],"x-oaiMeta":{"name":"The completion object","legacy":true,"example":"{\n \"id\": \"cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7\",\n \"object\": \"text_completion\",\n \"created\": 1589478378,\n \"model\": \"gpt-4-turbo\",\n \"choices\": [\n {\n \"text\": \"\\n\\nThis is indeed a test\",\n \"index\": 0,\n \"logprobs\": null,\n \"finish_reason\": \"length\"\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 5,\n \"completion_tokens\": 7,\n \"total_tokens\": 12\n }\n}\n"},"properties":{"id":{"type":"string","description":"A unique identifier for the completion.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"choices":{"type":"array","description":"The list of completion choices the model generated for the input prompt.","items":{"type":"object","required":["finish_reason","index","logprobs","text"],"properties":{"finish_reason":{"type":"string","description":"The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\nor `content_filter` if content was omitted due to a flag from our content filters.\n","enum":["stop","length","content_filter"],"isRequired":true,"uniqueKey":"choices.items.[INDEX].finish_reason","typeLabel":"enum\u003cstring>"},"index":{"type":"integer","isRequired":true,"uniqueKey":"choices.items.[INDEX].index","typeLabel":"integer"},"logprobs":{"oneOf":[{"type":"object","properties":{"text_offset":{"type":"array","items":{"type":"integer","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.text_offset.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.text_offset","typeLabel":"integer[]"},"token_logprobs":{"type":"array","items":{"type":"number","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.token_logprobs.items.[INDEX]","typeLabel":"number"},"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.token_logprobs","typeLabel":"number[]"},"tokens":{"type":"array","items":{"type":"string","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.tokens.items.[INDEX]","typeLabel":"string"},"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.tokens","typeLabel":"string[]"},"top_logprobs":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number","uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.top_logprobs.items.[INDEX].additionalProperties","typeLabel":"number"},"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.top_logprobs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0.top_logprobs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"text_offset":{"type":"array","items":{"type":"integer"}},"token_logprobs":{"type":"array","items":{"type":"number"}},"tokens":{"type":"array","items":{"type":"string"}},"top_logprobs":{"type":"array","items":{"type":"object","additionalProperties":{"type":"number"}}}},"isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"choices.items.[INDEX].logprobs","typeLabel":"object | null"},"text":{"type":"string","isRequired":true,"uniqueKey":"choices.items.[INDEX].text","typeLabel":"string"}},"uniqueKey":"choices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"choices","typeLabel":"object[]"},"created":{"type":"integer","description":"The Unix timestamp (in seconds) of when the completion was created.","isRequired":true,"uniqueKey":"created","typeLabel":"integer"},"model":{"type":"string","description":"The model used for completion.","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"object":{"type":"string","description":"The object type, which is always \"text_completion\"","enum":["text_completion"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"system_fingerprint":{"type":"string","description":"This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n","uniqueKey":"system_fingerprint","typeLabel":"string"},"usage":{"type":"object","description":"Usage statistics for the completion request.","properties":{"completion_tokens":{"type":"integer","description":"Number of tokens in the generated completion.","isRequired":true,"uniqueKey":"usage.completion_tokens","typeLabel":"integer"},"prompt_tokens":{"type":"integer","description":"Number of tokens in the prompt.","isRequired":true,"uniqueKey":"usage.prompt_tokens","typeLabel":"integer"},"total_tokens":{"type":"integer","description":"Total number of tokens used in the request (prompt + completion).","isRequired":true,"uniqueKey":"usage.total_tokens","typeLabel":"integer"},"completion_tokens_details":{"type":"object","description":"Breakdown of tokens used in a completion.","properties":{"accepted_prediction_tokens":{"type":"integer","description":"When using Predicted Outputs, the number of tokens in the\nprediction that appeared in the completion.\n","uniqueKey":"usage.completion_tokens_details.accepted_prediction_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","description":"Audio input tokens generated by the model.","uniqueKey":"usage.completion_tokens_details.audio_tokens","typeLabel":"integer"},"reasoning_tokens":{"type":"integer","description":"Tokens generated by the model for reasoning.","uniqueKey":"usage.completion_tokens_details.reasoning_tokens","typeLabel":"integer"},"rejected_prediction_tokens":{"type":"integer","description":"When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context window\nlimits.\n","uniqueKey":"usage.completion_tokens_details.rejected_prediction_tokens","typeLabel":"integer"}},"uniqueKey":"usage.completion_tokens_details","typeLabel":"object"},"prompt_tokens_details":{"type":"object","description":"Breakdown of tokens used in the prompt.","properties":{"audio_tokens":{"type":"integer","description":"Audio input tokens present in the prompt.","uniqueKey":"usage.prompt_tokens_details.audio_tokens","typeLabel":"integer"},"cached_tokens":{"type":"integer","description":"Cached tokens present in the prompt.","uniqueKey":"usage.prompt_tokens_details.cached_tokens","typeLabel":"integer"}},"uniqueKey":"usage.prompt_tokens_details","typeLabel":"object"}},"required":["prompt_tokens","completion_tokens","total_tokens"],"uniqueKey":"usage","typeLabel":"object"},"enkrypt_policy_detections":{"type":"object","description":"The policy detections for the completion.","properties":{"input_guardrails":{"title":"GuardrailsDetectionResponse","type":"object","required":["summary","details"],"properties":{"summary":{"type":"object","title":"GuardrailsDetectionResponseSummary","properties":{"nsfw":{"type":"integer","title":"NSFW Count","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.nsfw","typeLabel":"integer"},"toxicity":{"type":"array","title":"Toxicity Categories","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.toxicity.items.[INDEX]","typeLabel":"string"},"example":["toxicity","severe_toxicity","obscene","threat","insult","identity_hate"],"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.toxicity","typeLabel":"string[]"},"pii":{"type":"integer","title":"PII Count","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.pii","typeLabel":"integer"},"injection_attack":{"type":"integer","title":"Injection Attack","description":"1 when a prompt-injection or jailbreak attempt was detected, 0 otherwise. Which attack types fired is reported in details.injection_attack.detected_attacks.","example":1,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.injection_attack","typeLabel":"integer"},"keyword_detected":{"type":"integer","title":"Keyword Detected Count","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.keyword_detected","typeLabel":"integer"},"system_prompt_similarity":{"type":"integer","title":"System Prompt Similarity","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.system_prompt_similarity","typeLabel":"integer"},"copyright_ip_similarity":{"type":"integer","title":"Copyright/IP Similarity","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.copyright_ip_similarity","typeLabel":"integer"},"policy_violation":{"type":"integer","title":"Policy Adherence Count","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.policy_violation","typeLabel":"integer"},"bias":{"type":"integer","title":"Bias Count","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.bias","typeLabel":"integer"},"sponge_attack":{"type":"integer","title":"Sponge Attack Detected or not","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary.sponge_attack","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.summary","typeLabel":"GuardrailsDetectionResponseSummary · object"},"details":{"type":"object","title":"GuardrailsDetectionResponseDetails","properties":{"nsfw":{"type":"object","title":"NSFW Details","properties":{"sfw":{"type":"number","title":"Safe for Work Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.sfw","typeLabel":"number"},"nsfw":{"type":"number","title":"Not Safe for Work Score","example":0.9996041054725647,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.nsfw","typeLabel":"number"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.nsfw","typeLabel":"NSFW Details · object"},"toxicity":{"type":"object","title":"Toxicity Details","properties":{"toxicity":{"type":"number","title":"Toxicity Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.toxicity","typeLabel":"number"},"severe_toxicity":{"type":"number","format":"float","title":"Severe Toxicity Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.severe_toxicity","typeLabel":"number\u003cfloat>"},"obscene":{"type":"number","title":"Obscenity Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.obscene","typeLabel":"number"},"threat":{"type":"number","title":"Threat Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.threat","typeLabel":"number"},"insult":{"type":"number","title":"Insult Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.insult","typeLabel":"number"},"identity_hate":{"type":"number","title":"Identity Hate Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.identity_hate","typeLabel":"number"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.toxicity","typeLabel":"Toxicity Details · object"},"pii":{"type":"object","title":"PII Details","properties":{"secrets":{"type":"object","title":"Secrets Detected","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.secrets","typeLabel":"Secrets Detected · object"},"pii":{"type":"object","title":"PII Details","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.pii","typeLabel":"PII Details · object"},"ip_address":{"type":"object","title":"IP Addresses Detected","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.ip_address","typeLabel":"IP Addresses Detected · object"},"url":{"type":"object","title":"URLs Detected","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.url","typeLabel":"URLs Detected · object"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.pii","typeLabel":"PII Details · object"},"injection_attack":{"type":"object","title":"Injection Attack Details","properties":{"safe":{"type":"number","title":"Safe Score","example":"0.000004","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.safe","typeLabel":"number"},"attack":{"type":"number","title":"Attack Score","example":"0.999996","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.attack","typeLabel":"number"},"p_injection":{"type":"string","title":"Injection Probability","description":"Probability that the input is a prompt-injection attempt, to 6 decimal places.","example":"0.998970","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.p_injection","typeLabel":"string"},"p_jailbreak":{"type":"string","title":"Jailbreak Probability","description":"Probability that the input is a jailbreak attempt, to 6 decimal places.","example":"0.103658","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.p_jailbreak","typeLabel":"string"},"detected_attacks":{"type":"array","title":"Detected Attacks","description":"The attack types that fired. Empty when nothing was detected, and non-empty exactly when summary.injection_attack is 1. Populated on the text detect paths; the image and audio endpoints report only the summary verdict.","items":{"type":"string","enum":["injection","jailbreak"],"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.detected_attacks.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["injection"],"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.detected_attacks","typeLabel":"enum\u003cstring>[]"},"explanation":{"type":"string","title":"Explanation","description":"One-sentence reason for a confirmed attack. Populated only when the request set `need_explanation: true` and an attack was confirmed; an empty string otherwise.","example":"Instructs the AI to ignore its system prompt and reveal hidden instructions.","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.explanation","typeLabel":"string"},"most_unsafe_content":{"type":"string","title":"Most Unsafe Content","description":"The most unsafe content detected in the input","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.most_unsafe_content","typeLabel":"string"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.injection_attack","typeLabel":"Injection Attack Details · object"},"keyword_detector":{"type":"object","title":"Keyword Detector Details","properties":{"detected_keywords":{"type":"array","title":"Detected Keywords","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.keyword_detector.detected_keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.keyword_detector.detected_keywords","typeLabel":"string[]"},"detected_counts":{"type":"object","title":"Detected Counts","example":{"keyword1":1,"keyword2":2},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.keyword_detector.detected_counts","typeLabel":"Detected Counts · object"},"redacted_text":{"type":"string","title":"Redacted Text","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.keyword_detector.redacted_text","typeLabel":"string"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.keyword_detector","typeLabel":"Keyword Detector Details · object"},"system_prompt":{"type":"object","title":"System Prompt Similarity","properties":{"similarity_score":{"type":"integer","title":"Similarity Score","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.similarity_score","typeLabel":"integer"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.system_prompt","typeLabel":"System Prompt Similarity · object"},"copyright_ip":{"type":"object","title":"Copyright/IP Similarity Details","properties":{"similarity_score":{"type":"integer","title":"Similarity Score","example":0,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.similarity_score","typeLabel":"integer"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.copyright_ip","typeLabel":"Copyright/IP Similarity Details · object"},"policy_violation":{"type":"object","title":"Policy Adherence Details","properties":{"violating_policy":{"type":"string","title":"Violating Policy","description":"Legacy string of the violated policy line(s). Always returned regardless of whether the config used rules or policy_text.","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violating_policy","typeLabel":"string"},"violated_rules":{"type":"array","title":"Violated Rules","description":"NEW — full rule objects that were violated. Present ONLY when the request's policy_violation config used the structured `rules` array. On an ambiguous violation (empty/all markers) this contains every enforced rule (safe default).","items":{"title":"Rule","type":"object","properties":{"id":{"title":"Id","type":"string","example":"priv-1","isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].id","typeLabel":"string"},"text":{"title":"Text","type":"string","example":"The assistant must not provide individualized investment advice.","isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].text","typeLabel":"string"},"risk_category":{"title":"Risk Category","type":"string","example":"legal_ip_liability","enum":["security_fraud","safety_harm","privacy_data_protection","brand_reputation_trust","bias_fairness_ethical","legal_ip_liability","product_misuse_abuse","performance_reliability_quality"],"isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].risk_category","typeLabel":"enum\u003cstring>"},"applicability":{"title":"Applicability","type":"string","example":"assistant","enum":["assistant","user","user_assistant"],"isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].applicability","typeLabel":"enum\u003cstring>"},"severity":{"title":"Severity","type":"string","example":"medium","enum":["critical","high","medium","low"],"isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"source":{"title":"Source","type":"string","example":"document","enum":["document","catalog","document/catalog","user"],"isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"suggested":{"title":"Suggested","type":"boolean","example":false,"isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].suggested","typeLabel":"boolean"},"display_text":{"title":"Display Text","type":"string","example":"No individualized investment advice","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].display_text","typeLabel":"string"},"frameworks":{"title":"Frameworks","type":"array","items":{"type":"string","enum":["hipaa","finra","gdpr","ccpa","owasp_llm_2025","nist_ai_rmf","eu_ai_act","iso_42001"],"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].frameworks.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].frameworks","typeLabel":"enum\u003cstring>[]"},"mappings":{"title":"Mappings","type":"array","items":{"type":"object","properties":{"framework":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].mappings.items.[INDEX].framework","typeLabel":"string"},"clause":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].mappings.items.[INDEX].clause","typeLabel":"string"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].mappings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX].mappings","typeLabel":"Mappings · object[]"}},"required":["id","text","risk_category","applicability","severity","source","suggested"],"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules.items.[INDEX]","typeLabel":"Rule · object"},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.violated_rules","typeLabel":"Rule · object[]"},"explanation":{"type":"string","title":"Explanation","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.explanation","typeLabel":"string"},"most_unsafe_content":{"type":"string","title":"Most Unsafe Content","description":"The chunk of the input that triggered the violation. Empty string when no violation was found.","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation.most_unsafe_content","typeLabel":"string"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.policy_violation","typeLabel":"Policy Adherence Details · object"},"bias":{"type":"object","title":"Bias Details","properties":{"bias_detected":{"type":"boolean","title":"Bias Detected","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.bias_detected","typeLabel":"boolean"},"biased_text":{"type":"string","title":"Biased Text","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.biased_text","typeLabel":"string"},"debiased_text":{"type":"string","title":"Debiased Text","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.debiased_text","typeLabel":"string"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.bias","typeLabel":"Bias Details · object"},"sponge_attack":{"type":"object","title":"Sponge Attack Details","properties":{"sponge_attack_detected":{"type":"boolean","title":"Sponge Attack Detected","example":false,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.sponge_attack_detected","typeLabel":"boolean"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails.details.sponge_attack","typeLabel":"Sponge Attack Details · object"}},"isRequired":true,"uniqueKey":"enkrypt_policy_detections.input_guardrails.details","typeLabel":"GuardrailsDetectionResponseDetails · object"},"result_message":{"oneOf":[{"type":"string","title":"Result Message","description":"Block message when a block-type detector triggers (custom or built-in default), revised text when only revise-type detectors trigger, or null when no detections fire.","uniqueKey":"enkrypt_policy_detections.input_guardrails.result_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Result Message","description":"Block message when a block-type detector triggers (custom or built-in default), revised text when only revise-type detectors trigger, or null when no detections fire.","uniqueKey":"enkrypt_policy_detections.input_guardrails.result_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"enkrypt_policy_detections.input_guardrails.result_message","typeLabel":"string | null"},"user_metadata":{"type":"object","description":"Optional arbitrary metadata object echoed back in the response. Limits: at most 16 top-level keys, key names up to 64 characters, nesting depth up to 3, total serialized size up to 4 KB. When provided and valid, this object is also echoed as a top-level `user_metadata` key on error responses (4xx/5xx) of endpoints that accept it; invalid or oversized metadata is never echoed, including on the 422 response it causes.","additionalProperties":true,"maxProperties":16,"example":{"request_id":"abc-123","source":"mobile-app"},"uniqueKey":"enkrypt_policy_detections.input_guardrails.user_metadata","typeLabel":"object"}},"uniqueKey":"enkrypt_policy_detections.input_guardrails","typeLabel":"GuardrailsDetectionResponse · object"},"output_guardrails":{"title":"GuardrailsDetectionResponse","type":"object","required":["summary","details"],"properties":{"summary":{"type":"object","title":"GuardrailsDetectionResponseSummary","properties":{"nsfw":{"type":"integer","title":"NSFW Count","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.nsfw","typeLabel":"integer"},"toxicity":{"type":"array","title":"Toxicity Categories","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.toxicity.items.[INDEX]","typeLabel":"string"},"example":["toxicity","severe_toxicity","obscene","threat","insult","identity_hate"],"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.toxicity","typeLabel":"string[]"},"pii":{"type":"integer","title":"PII Count","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.pii","typeLabel":"integer"},"injection_attack":{"type":"integer","title":"Injection Attack","description":"1 when a prompt-injection or jailbreak attempt was detected, 0 otherwise. Which attack types fired is reported in details.injection_attack.detected_attacks.","example":1,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.injection_attack","typeLabel":"integer"},"keyword_detected":{"type":"integer","title":"Keyword Detected Count","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.keyword_detected","typeLabel":"integer"},"system_prompt_similarity":{"type":"integer","title":"System Prompt Similarity","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.system_prompt_similarity","typeLabel":"integer"},"copyright_ip_similarity":{"type":"integer","title":"Copyright/IP Similarity","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.copyright_ip_similarity","typeLabel":"integer"},"policy_violation":{"type":"integer","title":"Policy Adherence Count","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.policy_violation","typeLabel":"integer"},"bias":{"type":"integer","title":"Bias Count","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.bias","typeLabel":"integer"},"sponge_attack":{"type":"integer","title":"Sponge Attack Detected or not","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary.sponge_attack","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.summary","typeLabel":"GuardrailsDetectionResponseSummary · object"},"details":{"type":"object","title":"GuardrailsDetectionResponseDetails","properties":{"nsfw":{"type":"object","title":"NSFW Details","properties":{"sfw":{"type":"number","title":"Safe for Work Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.sfw","typeLabel":"number"},"nsfw":{"type":"number","title":"Not Safe for Work Score","example":0.9996041054725647,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.nsfw","typeLabel":"number"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.nsfw","typeLabel":"NSFW Details · object"},"toxicity":{"type":"object","title":"Toxicity Details","properties":{"toxicity":{"type":"number","title":"Toxicity Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.toxicity","typeLabel":"number"},"severe_toxicity":{"type":"number","format":"float","title":"Severe Toxicity Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.severe_toxicity","typeLabel":"number\u003cfloat>"},"obscene":{"type":"number","title":"Obscenity Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.obscene","typeLabel":"number"},"threat":{"type":"number","title":"Threat Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.threat","typeLabel":"number"},"insult":{"type":"number","title":"Insult Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.insult","typeLabel":"number"},"identity_hate":{"type":"number","title":"Identity Hate Score","example":0.000395895738620311,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.identity_hate","typeLabel":"number"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.toxicity","typeLabel":"Toxicity Details · object"},"pii":{"type":"object","title":"PII Details","properties":{"secrets":{"type":"object","title":"Secrets Detected","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.secrets","typeLabel":"Secrets Detected · object"},"pii":{"type":"object","title":"PII Details","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.pii","typeLabel":"PII Details · object"},"ip_address":{"type":"object","title":"IP Addresses Detected","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.ip_address","typeLabel":"IP Addresses Detected · object"},"url":{"type":"object","title":"URLs Detected","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.url","typeLabel":"URLs Detected · object"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.pii","typeLabel":"PII Details · object"},"injection_attack":{"type":"object","title":"Injection Attack Details","properties":{"safe":{"type":"number","title":"Safe Score","example":"0.000004","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.safe","typeLabel":"number"},"attack":{"type":"number","title":"Attack Score","example":"0.999996","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.attack","typeLabel":"number"},"p_injection":{"type":"string","title":"Injection Probability","description":"Probability that the input is a prompt-injection attempt, to 6 decimal places.","example":"0.998970","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.p_injection","typeLabel":"string"},"p_jailbreak":{"type":"string","title":"Jailbreak Probability","description":"Probability that the input is a jailbreak attempt, to 6 decimal places.","example":"0.103658","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.p_jailbreak","typeLabel":"string"},"detected_attacks":{"type":"array","title":"Detected Attacks","description":"The attack types that fired. Empty when nothing was detected, and non-empty exactly when summary.injection_attack is 1. Populated on the text detect paths; the image and audio endpoints report only the summary verdict.","items":{"type":"string","enum":["injection","jailbreak"],"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.detected_attacks.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["injection"],"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.detected_attacks","typeLabel":"enum\u003cstring>[]"},"explanation":{"type":"string","title":"Explanation","description":"One-sentence reason for a confirmed attack. Populated only when the request set `need_explanation: true` and an attack was confirmed; an empty string otherwise.","example":"Instructs the AI to ignore its system prompt and reveal hidden instructions.","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.explanation","typeLabel":"string"},"most_unsafe_content":{"type":"string","title":"Most Unsafe Content","description":"The most unsafe content detected in the input","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.most_unsafe_content","typeLabel":"string"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.injection_attack","typeLabel":"Injection Attack Details · object"},"keyword_detector":{"type":"object","title":"Keyword Detector Details","properties":{"detected_keywords":{"type":"array","title":"Detected Keywords","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.keyword_detector.detected_keywords.items.[INDEX]","typeLabel":"string"},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.keyword_detector.detected_keywords","typeLabel":"string[]"},"detected_counts":{"type":"object","title":"Detected Counts","example":{"keyword1":1,"keyword2":2},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.keyword_detector.detected_counts","typeLabel":"Detected Counts · object"},"redacted_text":{"type":"string","title":"Redacted Text","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.keyword_detector.redacted_text","typeLabel":"string"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.keyword_detector","typeLabel":"Keyword Detector Details · object"},"system_prompt":{"type":"object","title":"System Prompt Similarity","properties":{"similarity_score":{"type":"integer","title":"Similarity Score","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.similarity_score","typeLabel":"integer"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.system_prompt","typeLabel":"System Prompt Similarity · object"},"copyright_ip":{"type":"object","title":"Copyright/IP Similarity Details","properties":{"similarity_score":{"type":"integer","title":"Similarity Score","example":0,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.similarity_score","typeLabel":"integer"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.copyright_ip","typeLabel":"Copyright/IP Similarity Details · object"},"policy_violation":{"type":"object","title":"Policy Adherence Details","properties":{"violating_policy":{"type":"string","title":"Violating Policy","description":"Legacy string of the violated policy line(s). Always returned regardless of whether the config used rules or policy_text.","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violating_policy","typeLabel":"string"},"violated_rules":{"type":"array","title":"Violated Rules","description":"NEW — full rule objects that were violated. Present ONLY when the request's policy_violation config used the structured `rules` array. On an ambiguous violation (empty/all markers) this contains every enforced rule (safe default).","items":{"title":"Rule","type":"object","properties":{"id":{"title":"Id","type":"string","example":"priv-1","isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].id","typeLabel":"string"},"text":{"title":"Text","type":"string","example":"The assistant must not provide individualized investment advice.","isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].text","typeLabel":"string"},"risk_category":{"title":"Risk Category","type":"string","example":"legal_ip_liability","enum":["security_fraud","safety_harm","privacy_data_protection","brand_reputation_trust","bias_fairness_ethical","legal_ip_liability","product_misuse_abuse","performance_reliability_quality"],"isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].risk_category","typeLabel":"enum\u003cstring>"},"applicability":{"title":"Applicability","type":"string","example":"assistant","enum":["assistant","user","user_assistant"],"isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].applicability","typeLabel":"enum\u003cstring>"},"severity":{"title":"Severity","type":"string","example":"medium","enum":["critical","high","medium","low"],"isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"source":{"title":"Source","type":"string","example":"document","enum":["document","catalog","document/catalog","user"],"isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"suggested":{"title":"Suggested","type":"boolean","example":false,"isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].suggested","typeLabel":"boolean"},"display_text":{"title":"Display Text","type":"string","example":"No individualized investment advice","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].display_text","typeLabel":"string"},"frameworks":{"title":"Frameworks","type":"array","items":{"type":"string","enum":["hipaa","finra","gdpr","ccpa","owasp_llm_2025","nist_ai_rmf","eu_ai_act","iso_42001"],"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].frameworks.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].frameworks","typeLabel":"enum\u003cstring>[]"},"mappings":{"title":"Mappings","type":"array","items":{"type":"object","properties":{"framework":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].mappings.items.[INDEX].framework","typeLabel":"string"},"clause":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].mappings.items.[INDEX].clause","typeLabel":"string"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].mappings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX].mappings","typeLabel":"Mappings · object[]"}},"required":["id","text","risk_category","applicability","severity","source","suggested"],"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules.items.[INDEX]","typeLabel":"Rule · object"},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.violated_rules","typeLabel":"Rule · object[]"},"explanation":{"type":"string","title":"Explanation","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.explanation","typeLabel":"string"},"most_unsafe_content":{"type":"string","title":"Most Unsafe Content","description":"The chunk of the input that triggered the violation. Empty string when no violation was found.","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation.most_unsafe_content","typeLabel":"string"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.policy_violation","typeLabel":"Policy Adherence Details · object"},"bias":{"type":"object","title":"Bias Details","properties":{"bias_detected":{"type":"boolean","title":"Bias Detected","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.bias_detected","typeLabel":"boolean"},"biased_text":{"type":"string","title":"Biased Text","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.biased_text","typeLabel":"string"},"debiased_text":{"type":"string","title":"Debiased Text","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.debiased_text","typeLabel":"string"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.bias","typeLabel":"Bias Details · object"},"sponge_attack":{"type":"object","title":"Sponge Attack Details","properties":{"sponge_attack_detected":{"type":"boolean","title":"Sponge Attack Detected","example":false,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.sponge_attack_detected","typeLabel":"boolean"},"compliance_mapping":{"type":"object","title":"Compliance Mapping","description":"Mapping of detection to regulatory compliance frameworks","properties":{"owasp_llm_2025":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.owasp_llm_2025.items.[INDEX]","typeLabel":"string"},"title":"OWASP LLM Top 10 2025","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.owasp_llm_2025","typeLabel":"string[]"},"mitre_atlas":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.mitre_atlas.items.[INDEX]","typeLabel":"string"},"title":"MITRE ATLAS","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.mitre_atlas","typeLabel":"string[]"},"nist_ai_rmf":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.nist_ai_rmf.items.[INDEX]","typeLabel":"string"},"title":"NIST AI Risk Management Framework","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.nist_ai_rmf","typeLabel":"string[]"},"eu_ai_act":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.eu_ai_act.items.[INDEX]","typeLabel":"string"},"title":"EU AI Act","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.eu_ai_act","typeLabel":"string[]"},"iso_iec_standards":{"type":"array","items":{"type":"string","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.iso_iec_standards.items.[INDEX]","typeLabel":"string"},"title":"ISO/IEC Standards","uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping.iso_iec_standards","typeLabel":"string[]"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack.compliance_mapping","typeLabel":"Compliance Mapping · object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails.details.sponge_attack","typeLabel":"Sponge Attack Details · object"}},"isRequired":true,"uniqueKey":"enkrypt_policy_detections.output_guardrails.details","typeLabel":"GuardrailsDetectionResponseDetails · object"},"result_message":{"oneOf":[{"type":"string","title":"Result Message","description":"Block message when a block-type detector triggers (custom or built-in default), revised text when only revise-type detectors trigger, or null when no detections fire.","uniqueKey":"enkrypt_policy_detections.output_guardrails.result_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Result Message","description":"Block message when a block-type detector triggers (custom or built-in default), revised text when only revise-type detectors trigger, or null when no detections fire.","uniqueKey":"enkrypt_policy_detections.output_guardrails.result_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"enkrypt_policy_detections.output_guardrails.result_message","typeLabel":"string | null"},"user_metadata":{"type":"object","description":"Optional arbitrary metadata object echoed back in the response. Limits: at most 16 top-level keys, key names up to 64 characters, nesting depth up to 3, total serialized size up to 4 KB. When provided and valid, this object is also echoed as a top-level `user_metadata` key on error responses (4xx/5xx) of endpoints that accept it; invalid or oversized metadata is never echoed, including on the 422 response it causes.","additionalProperties":true,"maxProperties":16,"example":{"request_id":"abc-123","source":"mobile-app"},"uniqueKey":"enkrypt_policy_detections.output_guardrails.user_metadata","typeLabel":"object"}},"uniqueKey":"enkrypt_policy_detections.output_guardrails","typeLabel":"GuardrailsDetectionResponse · object"}},"uniqueKey":"enkrypt_policy_detections","typeLabel":"object"}},"uniqueKey":"","typeLabel":"EnkryptCreateChatCompletionResponse · object"},"examples":{"example":{"title":"example","value":{"id":"9023e384d9fa3af9","object":"chat.completion","created":1736923377,"model":"mistralai/Mixtral-8x7B-Instruct-v0.1","prompt":[],"choices":[{"finish_reason":"eos","seed":9320035192991048000,"logprobs":null,"index":0,"message":{"role":"assistant","content":" Hello! How can I help you today? If you have any questions about a specific topic or just want to chat, feel free to ask. I'm here to provide information and engage in a friendly conversation.","tool_calls":[]}}],"usage":{"prompt_tokens":10,"completion_tokens":44,"total_tokens":54},"enkrypt_policy_detections":{"output_guardrails":{"details":{"keyword_detector":{"detected_counts":{},"redacted_text":" Hello! How can I assist you today?","detected_keywords":{}},"policy_violation":{"violating_policy":"No Violation Found","explanation":"No Violation Found.","most_unsafe_content":""},"bias":{"bias_detected":false,"debiased_text":"Hello! How may I help you today?"},"pii":{"ip_address":{},"url":{},"pii":{},"secrets":{}},"nsfw":{"sfw":0.77364963293076,"nsfw":0.14463838934898},"toxicity":{"threat":0.00013719938579015,"severe_toxicity":0.00013394378765952,"obscene":0.00018259837816004,"insult":0.00018637960602064,"toxicity":0.00058524927590042,"identity_hate":0.00014582877338398},"injection_attack":{"safe":"0.998087","attack":"0.001913","p_injection":"0.001913","p_jailbreak":"0.000318","detected_attacks":[]}},"summary":{"keyword_detected":0,"policy_violation":0,"bias":0,"pii":0,"nsfw":0,"toxicity":{},"injection_attack":0}},"input_guardrails":{"details":{"keyword_detector":{"detected_counts":{},"redacted_text":"|","detected_keywords":{}},"policy_violation":{"violating_policy":"No Violation Found","explanation":"No Violation Found.","most_unsafe_content":""},"bias":{"bias_detected":false,"debiased_text":"No rephrasing needed."},"pii":{"ip_address":{},"url":{},"pii":{},"secrets":{}},"nsfw":{"sfw":0.23262414336205,"nsfw":0.75041556358337},"toxicity":{"threat":0.0001007060345728,"severe_toxicity":0.00010207855666522,"obscene":0.00019277907267679,"insult":0.00018571241525933,"toxicity":0.0011186309857294,"identity_hate":0.00013926414248999},"injection_attack":{"safe":"0.999906","attack":"0.000094","p_injection":"0.000094","p_jailbreak":"0.000318","detected_attacks":[]}},"summary":{"keyword_detected":0,"policy_violation":0,"bias":0,"pii":0,"nsfw":1,"toxicity":{},"injection_attack":0}}}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"8565320a-4e60-418d-8700-2d1d509f0638":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"apikey","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"46d259d2-9225-46ce-aca1-4e05427371e5":{"url":"https://api.enkryptai.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"apikey","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"apikey","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"apikey"}],"title":"apiKeyAuth"}]},"originalFileLocation":"enkrypt-openapi.json"},"subdomain":"enkryptai-42","siteName":"Enkrypt AI","title":"AI Chat Completions Proxy Endpoint - Enkrypt AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T09:28:10.947Z","originalFileLocation":"api-reference/ai-proxy-api-reference/endpoint/chat-completions.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=\"light\"}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=\"application-name\" content=\"Enkrypt AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/enkryptai-42/zTk8P2FqD4OFror7/_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/enkryptai-42/zTk8P2FqD4OFror7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/enkryptai-42/zTk8P2FqD4OFror7/_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/enkryptai-42/zTk8P2FqD4OFror7/_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/enkryptai-42/zTk8P2FqD4OFror7/_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/enkryptai-42/zTk8P2FqD4OFror7/_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/enkryptai-42/zTk8P2FqD4OFror7/_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/enkryptai-42/zTk8P2FqD4OFror7/_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/enkryptai-42/zTk8P2FqD4OFror7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"AI Chat Completions Proxy Endpoint - Enkrypt AI\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Enkrypt AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://enkryptai-42.mintlify.app/_mintlify/api/og/v2?division=%F0%9F%94%8C+AI+Proxy+API\u0026amp;title=AI+Chat+Completions+Proxy+Endpoint\u0026amp;theme=3d60806929a37a29522c9c45\u0026amp;signature=73c59a736fd55bb5bf8ddceb7d65eec12291f4b11b7a28cd39344fbd21c3729d\">\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=\"AI Chat Completions Proxy Endpoint - Enkrypt AI\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://enkryptai-42.mintlify.app/_mintlify/api/og/v2?division=%F0%9F%94%8C+AI+Proxy+API\u0026amp;title=AI+Chat+Completions+Proxy+Endpoint\u0026amp;theme=3d60806929a37a29522c9c45\u0026amp;signature=73c59a736fd55bb5bf8ddceb7d65eec12291f4b11b7a28cd39344fbd21c3729d\">\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/enkryptai-42/zTk8P2FqD4OFror7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Enkrypt AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff6b6b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/ai-proxy-api-reference/endpoint/chat-completions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.enkryptai.com/#organization\",\"name\":\"Enkrypt AI\",\"url\":\"https://docs.enkryptai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/enkryptai-42/7kWxrBaXsO0YvXjU/logo/light-logo.png?fit=max\u0026auto=format\u0026n=7kWxrBaXsO0YvXjU\u0026q=85\u0026s=3e4d5072cef08dc6b8885a03a7821b72\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.enkryptai.com#website\",\"name\":\"Enkrypt AI\",\"url\":\"https://docs.enkryptai.com\",\"publisher\":{\"@id\":\"https://docs.enkryptai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions#webpage\",\"url\":\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions\",\"name\":\"AI Chat Completions Proxy Endpoint\",\"dateModified\":\"2026-10-28T09:28:10.947Z\",\"isPartOf\":{\"@id\":\"https://docs.enkryptai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.enkryptai.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"AI Chat Completions Proxy Endpoint\",\"item\":\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions#apireference\",\"headline\":\"AI Chat Completions Proxy Endpoint\",\"name\":\"AI Chat Completions Proxy Endpoint\",\"url\":\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.enkryptai.com/api-reference/ai-proxy-api-reference/endpoint/chat-completions#webpage\"},\"dateModified\":\"2026-10-28T09:28:10.947Z\",\"publisher\":{\"@id\":\"https://docs.enkryptai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.enkryptai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Enkrypt AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Enkrypt AI","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home/introduction"}]},{"tab":"Get Started","pages":[{"title":"Get Started","href":"/get-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Overview","href":"/api-reference/introduction"},{"group":"📋 Code of Conduct API","pages":[{"title":"Infer Document","openapi":"POST /guardrails/policy-wizard/infer-document","href":"/api-reference/coc-api-reference/endpoint/infer-document"},{"title":"Generate Rules","openapi":"POST /guardrails/policy-wizard/generate-rules","href":"/api-reference/coc-api-reference/endpoint/generate-rules"},{"title":"Add Policy","openapi":"POST /code-of-conduct/add-policy","href":"/api-reference/coc-api-reference/endpoint/add-policy"},{"title":"Get Policy","openapi":"GET /code-of-conduct/get-policy","href":"/api-reference/coc-api-reference/endpoint/get-policy"},{"title":"Modify Policy","openapi":"PATCH /code-of-conduct/modify-policy","href":"/api-reference/coc-api-reference/endpoint/modify-policy"},{"title":"Delete Policy","openapi":"DELETE /code-of-conduct/delete-policy","href":"/api-reference/coc-api-reference/endpoint/delete-policy"},{"title":"List Policies","openapi":"GET /code-of-conduct/list-policies","href":"/api-reference/coc-api-reference/endpoint/list-policies"}]},{"group":"🛡️ Guardrails API Endpoints","pages":[{"openapi":"GET /guardrails/health","title":"Health Check","href":"/api-reference/guardrails-api-reference/endpoint/health-check"},{"openapi":"GET /guardrails/status","title":"Status Check","href":"/api-reference/guardrails-api-reference/endpoint/status"},{"openapi":"GET /guardrails/models","title":"Models Loaded","href":"/api-reference/guardrails-api-reference/endpoint/models"},{"openapi":"POST /guardrails/detect","title":"Guardrails Detect","href":"/api-reference/guardrails-api-reference/endpoint/detect"},{"openapi":"POST /guardrails/batch/detect","title":"Guardrails Batch Detect","href":"/api-reference/guardrails-api-reference/endpoint/batch-detect"},{"title":"Scan URL","openapi":"POST /guardrails/scan-url","href":"/api-reference/guardrails-api-reference/endpoint/scan-url"},{"title":"Scan PDF","openapi":"POST /guardrails/scan-pdf","href":"/api-reference/guardrails-api-reference/endpoint/scan-pdf"},{"title":"Detect Image","openapi":"POST /guardrails/detect-image","href":"/api-reference/guardrails-api-reference/endpoint/detect-image"},{"title":"Detect Audio","openapi":"POST /guardrails/detect-audio","href":"/api-reference/guardrails-api-reference/endpoint/detect-audio"},{"title":"Guardrail Detect Image","openapi":"POST /guardrails/guardrail/detect-image","href":"/api-reference/guardrails-api-reference/endpoint/guardrail-detect-image"},{"title":"Guardrail Detect Audio","openapi":"POST /guardrails/guardrail/detect-audio","href":"/api-reference/guardrails-api-reference/endpoint/guardrail-detect-audio"},{"openapi":"POST /guardrails/pii","title":"PII anonymization and de-anonymization","href":"/api-reference/guardrails-api-reference/endpoint/pii"},{"openapi":"POST /guardrails/hallucination","title":"Detect Hallucination","href":"/api-reference/guardrails-api-reference/endpoint/hallucination"},{"openapi":"POST /guardrails/adherence","title":"Guardrails Adherence","href":"/api-reference/guardrails-api-reference/endpoint/adherence"},{"openapi":"POST /guardrails/relevancy","title":"Guardrails Relevancy","href":"/api-reference/guardrails-api-reference/endpoint/relevancy"},{"title":"Add Guardrail","openapi":"POST /guardrails/add-guardrail","href":"/api-reference/guardrails-api-reference/endpoint/add-guardrail"},{"title":"Get Guardrail","openapi":"GET /guardrails/get-guardrail","href":"/api-reference/guardrails-api-reference/endpoint/get-guardrail"},{"title":"Modify Guardrail","openapi":"PATCH /guardrails/modify-guardrail","href":"/api-reference/guardrails-api-reference/endpoint/modify-guardrail"},{"title":"Delete Guardrail","openapi":"DELETE /guardrails/delete-guardrail","href":"/api-reference/guardrails-api-reference/endpoint/delete-guardrail"},{"title":"List Guardrails","openapi":"GET /guardrails/list-guardrails","href":"/api-reference/guardrails-api-reference/endpoint/list-guardrails"},{"title":"Detect with Guardrail","openapi":"POST /guardrails/guardrail/detect","href":"/api-reference/guardrails-api-reference/endpoint/detect-using-guardrail"},{"title":"Batch Detect with Guardrail","openapi":"POST /guardrails/guardrail/batch/detect","href":"/api-reference/guardrails-api-reference/endpoint/batch-detect-using-guardrail"},{"title":"Guardrail Scan URL","openapi":"POST /guardrails/guardrail/scan-url","href":"/api-reference/guardrails-api-reference/endpoint/guardrail-scan-url"},{"title":"Guardrail Scan PDF","openapi":"POST /guardrails/guardrail/scan-pdf","href":"/api-reference/guardrails-api-reference/endpoint/guardrail-scan-pdf"}]},{"group":"🤖 Models API (Endpoints)","pages":[{"openapi":"POST /models/add-model","title":"Create Model","href":"/api-reference/models-api-reference/endpoint/add-model"},{"openapi":"GET /models/get-model","title":"Get Model","href":"/api-reference/models-api-reference/endpoint/get-model"},{"openapi":"PATCH /models/modify-model","title":"Modify Model","href":"/api-reference/models-api-reference/endpoint/modify-model"},{"openapi":"DELETE /models/delete-model","title":"Delete Model","href":"/api-reference/models-api-reference/endpoint/delete-model"},{"title":"List Models","openapi":"GET /models/list-models","href":"/api-reference/models-api-reference/endpoint/list-models"},{"openapi":"GET /models/get-defaults","title":"Get Defaults","href":"/api-reference/models-api-reference/endpoint/get-defaults"}]},{"group":"🔴 Red Team API","pages":[{"openapi":"POST /rt/redteam","title":"Run Redteam","href":"/api-reference/redteam-v2-api-reference/endpoint/run-redteam"},{"openapi":"POST /rt/model/redteam","title":"Run Redteam with saved model","href":"/api-reference/redteam-v2-api-reference/endpoint/run-redteam-saved-model"},{"openapi":"POST /rt/redteam/jailbreak","title":"Run Jailbreak Benchmark","href":"/api-reference/redteam-v2-api-reference/endpoint/run-jailbreak"},{"openapi":"POST /rt/model/redteam/jailbreak","title":"Run Jailbreak Benchmark with saved model","href":"/api-reference/redteam-v2-api-reference/endpoint/run-jailbreak-saved-model"},{"openapi":"POST /rt/threat-modeling","title":"Run Threat Modeling","href":"/api-reference/redteam-v2-api-reference/endpoint/run-threat-modeling"},{"openapi":"POST /rt/threat-modeling/categories","title":"Run Threat Modeling Categories","href":"/api-reference/redteam-v2-api-reference/endpoint/run-threat-modeling-categories"},{"openapi":"POST /rt/threat-modeling/data","title":"Run Threat Modeling Data","href":"/api-reference/redteam-v2-api-reference/endpoint/run-threat-modeling-data"},{"openapi":"POST /rt/playground","title":"Run Playground","href":"/api-reference/redteam-v2-api-reference/endpoint/run-playground"},{"openapi":"POST /rt/model/playground","title":"Run Playground with saved model","href":"/api-reference/redteam-v2-api-reference/endpoint/run-playground-saved-model"},{"openapi":"POST /rt/eval","title":"Submit Eval Batch","href":"/api-reference/redteam-v2-api-reference/endpoint/submit-eval"},{"openapi":"POST /rt/leaderboard","title":"Run Leaderboard","href":"/api-reference/redteam-v2-api-reference/endpoint/run-leaderboard"},{"openapi":"POST /rt/model/leaderboard","title":"Run Leaderboard with saved model","href":"/api-reference/redteam-v2-api-reference/endpoint/run-leaderboard-saved-model"},{"openapi":"GET /rt/runs/{run_id}","title":"Get Run Status","href":"/api-reference/redteam-v2-api-reference/endpoint/get-run-status"},{"openapi":"GET /rt/runs/{run_id}/records","title":"Get Run Records","href":"/api-reference/redteam-v2-api-reference/endpoint/get-run-records"},{"openapi":"GET /rt/runs/{run_id}/results","title":"Get Run Results","href":"/api-reference/redteam-v2-api-reference/endpoint/get-run-results"},{"openapi":"GET /rt/runs/{run_id}/compliance/{framework_id}","title":"Get Compliance Report","href":"/api-reference/redteam-v2-api-reference/endpoint/get-compliance-report"},{"openapi":"POST /rt/runs/{run_id}/signal/{name}","title":"Send Signal","href":"/api-reference/redteam-v2-api-reference/endpoint/send-signal"},{"openapi":"POST /rt/runs/{run_id}/resume","title":"Resume Run","href":"/api-reference/redteam-v2-api-reference/endpoint/resume-run"},{"openapi":"GET /rt/runs/{run_id}/stream","title":"Stream Run Events","href":"/api-reference/redteam-v2-api-reference/endpoint/stream-run-events"},{"openapi":"GET /wss/redteam/v1/logs/tasks/{owner_id}/{job_id}/{model_folder}/app.log","playground":"none","title":"Stream Run Logs (WebSocket)","href":"/api-reference/redteam-v2-api-reference/endpoint/stream-run-logs"},{"openapi":"GET /rt/datasets/{dataset_id}","title":"Get Dataset","href":"/api-reference/redteam-v2-api-reference/endpoint/get-dataset"},{"openapi":"POST /rt/model-health","title":"Model Health","href":"/api-reference/redteam-v2-api-reference/endpoint/model-health"},{"openapi":"POST /rt/model/model-health","title":"Model Health with saved model","href":"/api-reference/redteam-v2-api-reference/endpoint/model-health-saved"},{"openapi":"GET /redteam/relay/v1/relay/bridge","playground":"none","title":"Connect a relay bridge (WebSocket)","href":"/api-reference/redteam-v2-api-reference/endpoint/relay-bridge-connect"},{"openapi":"GET /redteam/relay/v1/relay/bridges/{bridge_id}/status","title":"Relay bridge status","href":"/api-reference/redteam-v2-api-reference/endpoint/relay-bridge-status"},{"openapi":"POST /rt/findings","title":"Get findings based on summary","href":"/api-reference/redteam-v2-api-reference/endpoint/get-findings"},{"openapi":"POST /rt/risk-mitigation/system-prompt","title":"Generate a system prompt for risk mitigation based on red teaming test results","href":"/api-reference/redteam-v2-api-reference/endpoint/risk-mitigation-system-prompt"},{"openapi":"POST /rt/risk-mitigation/guardrails-policy","title":"Generate a guardrail and policy for risk mitigation based on summary","href":"/api-reference/redteam-v2-api-reference/endpoint/risk-mitigation-guardrails-policy"},{"openapi":"GET /rt/health","title":"Red Team Health","href":"/api-reference/redteam-v2-api-reference/endpoint/health"},{"openapi":"GET /rt/status-check","title":"Red Team Status Check","href":"/api-reference/redteam-v2-api-reference/endpoint/status-check"}]},{"group":"🚀 Deployments API","pages":[{"openapi":"POST /deployments/add-deployment","title":"Create Deployment","href":"/api-reference/deployments-api-reference/endpoint/add-deployment"},{"openapi":"GET /deployments/get-deployment","title":"Get Deployment","href":"/api-reference/deployments-api-reference/endpoint/get-deployment"},{"openapi":"PATCH /deployments/modify-deployment","title":"Modify Deployment","href":"/api-reference/deployments-api-reference/endpoint/modify-deployment"},{"openapi":"DELETE /deployments/delete-deployment","title":"Delete Deployment","href":"/api-reference/deployments-api-reference/endpoint/delete-deployment"},{"title":"List Deployments","openapi":"GET /deployments/list-deployments","href":"/api-reference/deployments-api-reference/endpoint/list-deployments"},{"openapi":"GET /deployments/get-allowed-config","title":"Get Allowed Config","description":null,"href":"/api-reference/deployments-api-reference/endpoint/get-allowed-config"}]},{"group":"🔌 AI Proxy API","pages":[{"openapi":"POST /ai-proxy/chat/completions","title":"AI Chat Completions Proxy Endpoint","href":"/api-reference/ai-proxy-api-reference/endpoint/chat-completions"},{"openapi":"POST /ai-proxy/completions","title":"AI Completions Proxy Endpoint","description":null,"href":"/api-reference/ai-proxy-api-reference/endpoint/completions"}]},{"group":"🔒 MCP Hub API","pages":[{"openapi":"POST /mcp-hub/scan","title":"Start a New Vulnerability Scan","href":"/api-reference/mcp-hub-api-reference/endpoint/scan"},{"openapi":"POST /mcp-hub/scan/hosted","title":"Scan a Hosted MCP Server","href":"/api-reference/mcp-hub-api-reference/endpoint/hosted-scan"},{"openapi":"POST /mcp-hub/scan/hosted/config","title":"Scan MCP Servers from Config JSON","href":"/api-reference/mcp-hub-api-reference/endpoint/hosted-scan-from-config"},{"openapi":"GET /mcp-hub/scan/{job_id}/status","title":"Get Scan Job Status","href":"/api-reference/mcp-hub-api-reference/endpoint/get-status"},{"openapi":"GET /mcp-hub/scan/{job_id}/results","title":"Get Complete Scan Results","href":"/api-reference/mcp-hub-api-reference/endpoint/get-results"},{"openapi":"GET /mcp-hub/scans","title":"List Scans","href":"/api-reference/mcp-hub-api-reference/endpoint/list-scans"},{"openapi":"GET /mcp-hub/dashboard-stats","title":"Get MCP Hub Scan Statistics","href":"/api-reference/mcp-hub-api-reference/endpoint/dashboard-stats"},{"openapi":"GET /mcp-hub/usage","title":"Get MCP Hub API Usage Summary","href":"/api-reference/mcp-hub-api-reference/endpoint/usage"}]},{"group":"🗂️ MCP Registry Servers API","pages":[{"openapi":"POST /mcp-registry/add-server","title":"Create MCP Registry Server","href":"/api-reference/mcp-registry-servers-api-reference/endpoint/add-server"},{"openapi":"POST /mcp-registry/bulk-add-servers","title":"Bulk-create MCP Registry Servers (atomic)","href":"/api-reference/mcp-registry-servers-api-reference/endpoint/bulk-add-servers"},{"openapi":"GET /mcp-registry/get-server","title":"Get MCP Registry Server","href":"/api-reference/mcp-registry-servers-api-reference/endpoint/get-server"},{"openapi":"PATCH /mcp-registry/modify-server","title":"Update MCP Registry Server","href":"/api-reference/mcp-registry-servers-api-reference/endpoint/modify-server"},{"openapi":"DELETE /mcp-registry/delete-server","title":"Delete MCP Registry Server","href":"/api-reference/mcp-registry-servers-api-reference/endpoint/delete-server"},{"openapi":"GET /mcp-registry/list-servers","title":"List MCP Registry Servers","href":"/api-reference/mcp-registry-servers-api-reference/endpoint/list-servers"},{"openapi":"GET /mcp-registry/list-gateways-by-server","title":"List Gateways by Registry Server","href":"/api-reference/mcp-registry-servers-api-reference/endpoint/list-gateways-by-server"}]},{"group":"🚪 MCP Gateways API","pages":[{"openapi":"POST /mcp-gateway/add-gateway","title":"Create MCP Gateway","href":"/api-reference/mcp-gateways-api-reference/endpoint/add-gateway"},{"openapi":"GET /mcp-gateway/get-gateway","title":"Get MCP Gateway","href":"/api-reference/mcp-gateways-api-reference/endpoint/get-gateway"},{"openapi":"GET /mcp-gateway/get-gateway-config","title":"Get Expanded MCP Gateway Configuration","href":"/api-reference/mcp-gateways-api-reference/endpoint/get-gateway-config"},{"openapi":"PATCH /mcp-gateway/modify-gateway","title":"Update MCP Gateway","href":"/api-reference/mcp-gateways-api-reference/endpoint/modify-gateway"},{"openapi":"DELETE /mcp-gateway/delete-gateway","title":"Delete MCP Gateway","href":"/api-reference/mcp-gateways-api-reference/endpoint/delete-gateway"},{"openapi":"GET /mcp-gateway/list-gateways","title":"List MCP Gateways","href":"/api-reference/mcp-gateways-api-reference/endpoint/list-gateways"}]},{"group":"🧪 MCP Playground API","pages":[{"openapi":"POST /mcp-playground/test-server","title":"Test MCP Server Connectivity","href":"/api-reference/mcp-playground-api-reference/endpoint/test-server"},{"openapi":"GET /mcp-playground/get-tools","title":"Get MCP Server Tools","href":"/api-reference/mcp-playground-api-reference/endpoint/get-tools"},{"openapi":"POST /mcp-playground/call-tool","title":"Call MCP Server Tool","href":"/api-reference/mcp-playground-api-reference/endpoint/call-tool"}]},{"group":"📜 Skill Scanner API","pages":[{"openapi":"POST /skill-hub/scan","title":"Submit a Skill Scan","href":"/api-reference/skill-scanner-api-reference/endpoint/scan"},{"openapi":"GET /skill-hub/scans/{scan_id}","title":"Get Skill Scan","href":"/api-reference/skill-scanner-api-reference/endpoint/get-scan"},{"openapi":"GET /skill-hub/scans/{scan_id}/report","title":"Get Skill Scan Report","href":"/api-reference/skill-scanner-api-reference/endpoint/get-report"},{"openapi":"GET /skill-hub/scans","title":"List Skill Scans","href":"/api-reference/skill-scanner-api-reference/endpoint/list-scans"},{"openapi":"GET /skill-hub/healthz","title":"Skill Scanner Health","href":"/api-reference/skill-scanner-api-reference/endpoint/health"}]},{"group":"⚖️ Compliance API","pages":[{"openapi":"POST /compliance/test-connection","title":"Test Compliance Connection","href":"/api-reference/compliance-api-reference/endpoint/test-connection"},{"openapi":"POST /compliance/add-scan","title":"Add Compliance Scan","href":"/api-reference/compliance-api-reference/endpoint/add-scan"},{"openapi":"GET /compliance/get-scan","title":"Get Compliance Scan","href":"/api-reference/compliance-api-reference/endpoint/get-scan"},{"openapi":"PATCH /compliance/modify-scan","title":"Modify Compliance Scan","href":"/api-reference/compliance-api-reference/endpoint/modify-scan"},{"openapi":"DELETE /compliance/delete-scan","title":"Delete Compliance Scan","href":"/api-reference/compliance-api-reference/endpoint/delete-scan"},{"openapi":"GET /compliance/list-scans","title":"List Compliance Scans","href":"/api-reference/compliance-api-reference/endpoint/list-scans"},{"openapi":"POST /compliance/start-scan","title":"Start Compliance Scan","href":"/api-reference/compliance-api-reference/endpoint/start-scan"},{"openapi":"POST /compliance/pause-scan","title":"Pause Compliance Scan","href":"/api-reference/compliance-api-reference/endpoint/pause-scan"},{"openapi":"GET /compliance/list-log-files","title":"List Compliance Log Files","href":"/api-reference/compliance-api-reference/endpoint/list-log-files"},{"openapi":"GET /compliance/get-message","title":"Get Compliance Message","href":"/api-reference/compliance-api-reference/endpoint/get-message"}]},{"group":"🏆 Leaderboard API","pages":[{"openapi":"GET /leaderboard/v2/models-list","title":"v2 Models List","href":"/api-reference/leaderboard-api-reference/endpoint/v2/models/models-list"},{"openapi":"GET /leaderboard/v2/scores","title":"v2 Scores list","href":"/api-reference/leaderboard-api-reference/endpoint/v2/scores/scores-list"},{"openapi":"GET /leaderboard/v2/scores/{modelName}","title":"v2 Model Score","href":"/api-reference/leaderboard-api-reference/endpoint/v2/scores/model-score"},{"openapi":"GET /leaderboard/v2/details/{modelName}","title":"v2 Model Detail","href":"/api-reference/leaderboard-api-reference/endpoint/v2/details/model-detail"},{"openapi":"GET /leaderboard/v2/summary/{modelName}","title":"v2 Model Summary","href":"/api-reference/leaderboard-api-reference/endpoint/v2/summary/model-summary"},{"openapi":"GET /leaderboard/v2/rank/{modelName}","title":"v2 Model Rank","href":"/api-reference/leaderboard-api-reference/endpoint/v2/rank/model-rank"},{"openapi":"GET /leaderboard/v2/percentiles","title":"v2 Models Risk Percentiles","href":"/api-reference/leaderboard-api-reference/endpoint/v2/percentiles/models-risk-percentiles"}]},{"group":"🗃️ Archived","pages":[{"group":"Datasets (Legacy)","pages":[{"openapi":"POST /datasets/add-task","title":"Datasets Add Task","href":"/api-reference/datasets-api-reference/endpoint/add-task"},{"openapi":"GET /datasets/task-status","title":"Datasets Get Task Status","href":"/api-reference/datasets-api-reference/endpoint/task-status"},{"openapi":"GET /datasets/get-task","title":"Datasets Get Task","href":"/api-reference/datasets-api-reference/endpoint/get-task"},{"openapi":"GET /datasets/get-datacard","title":"Datasets Get Datacard","href":"/api-reference/datasets-api-reference/endpoint/get-datacard"},{"openapi":"GET /datasets/get-dataset","title":"Datasets Get Dataset","href":"/api-reference/datasets-api-reference/endpoint/get-dataset"},{"openapi":"GET /datasets/get-summary","title":"Datasets Get Summary","href":"/api-reference/datasets-api-reference/endpoint/get-summary"},{"title":"List Tasks","openapi":"GET /datasets/list-tasks","href":"/api-reference/datasets-api-reference/endpoint/list-tasks"}]},{"group":"Guardrails Policy (Legacy)","pages":[{"title":"Add Policy (Legacy)","openapi":"POST /guardrails/add-policy","href":"/api-reference/guardrails-api-reference/endpoint/add-policy"},{"title":"Get Policy (Legacy)","openapi":"GET /guardrails/get-policy","href":"/api-reference/guardrails-api-reference/endpoint/get-policy"},{"title":"Modify Policy (Legacy)","openapi":"PATCH /guardrails/modify-policy","href":"/api-reference/guardrails-api-reference/endpoint/modify-policy"},{"title":"Delete Policy (Legacy)","openapi":"DELETE /guardrails/delete-policy","href":"/api-reference/guardrails-api-reference/endpoint/delete-policy"},{"title":"List Policies (Legacy)","openapi":"GET /guardrails/list-policies","href":"/api-reference/guardrails-api-reference/endpoint/list-policies"},{"title":"Detect with Policy (Legacy)","openapi":"POST /guardrails/policy/detect","href":"/api-reference/guardrails-api-reference/endpoint/detect-using-policy"},{"title":"Detect Image with Policy (Legacy)","openapi":"POST /guardrails/policy/detect-image","href":"/api-reference/guardrails-api-reference/endpoint/detect-image-using-policy"},{"title":"Detect Audio with Policy (Legacy)","openapi":"POST /guardrails/policy/detect-audio","href":"/api-reference/guardrails-api-reference/endpoint/detect-audio-using-policy"},{"title":"Policy Batch Detect (Legacy)","openapi":"POST /guardrails/policy/batch/detect","href":"/api-reference/guardrails-api-reference/endpoint/batch-detect-using-policy"},{"title":"Policy Scan URL (Legacy)","openapi":"POST /guardrails/policy/scan-url","href":"/api-reference/guardrails-api-reference/endpoint/policy-scan-url"},{"title":"Policy Scan PDF (Legacy)","openapi":"POST /guardrails/policy/scan-pdf","href":"/api-reference/guardrails-api-reference/endpoint/policy-scan-pdf"}]},{"group":"Red Team (Legacy)","pages":[{"openapi":"GET /redteam/health","title":"Redteam Health","href":"/api-reference/redteam-api-reference/endpoint/health"},{"openapi":"POST /redteam/v3/model-health","title":"Model Health (V3)","href":"/api-reference/redteam-api-reference/endpoint/v3-model-health"},{"openapi":"POST /redteam/model/model-health","title":"Model Health of saved model","href":"/api-reference/redteam-api-reference/endpoint/model-health-saved"},{"openapi":"POST /redteam/v3/add-custom-task","title":"Add Custom Task (V3)","href":"/api-reference/redteam-api-reference/endpoint/v3-add-custom-task"},{"openapi":"POST /redteam/v3/model/add-custom-task","title":"Add Custom Task with saved model (V3)","href":"/api-reference/redteam-api-reference/endpoint/v3-model-add-custom-task"},{"openapi":"PATCH /redteam/cancel-task","title":"Cancel Task","href":"/api-reference/redteam-api-reference/endpoint/cancel-task"},{"openapi":"GET /redteam/get-task","title":"Get Task","href":"/api-reference/redteam-api-reference/endpoint/get-task"},{"openapi":"GET /redteam/task-status","title":"Get Task Status","href":"/api-reference/redteam-api-reference/endpoint/get-task-status"},{"openapi":"GET /redteam/download-link","title":"Get Download Link","href":"/api-reference/redteam-api-reference/endpoint/get-download-link"},{"openapi":"GET /redteam/v3/results/summary","title":"Get Task Results Summary","href":"/api-reference/redteam-api-reference/endpoint/get-results-summary"},{"openapi":"GET /redteam/v3/results/summary/{test_type}","title":"Get Task Results Summary of a specific test type","href":"/api-reference/redteam-api-reference/endpoint/get-summary-test-type"},{"openapi":"GET /redteam/v3/results/details","title":"Get Task Results Details","href":"/api-reference/redteam-api-reference/endpoint/get-all-details"},{"openapi":"GET /redteam/v3/results/details/{test_type}","title":"Get Task Results Details of a specific test type","href":"/api-reference/redteam-api-reference/endpoint/get-details-test-type"},{"openapi":"POST /redteam/findings","title":"Get findings based on summary","href":"/api-reference/redteam-api-reference/endpoint/get-findings"},{"openapi":"POST /redteam/risk-mitigation/system-prompt","title":"Generate a system prompt for risk mitigation based on red teaming test results","href":"/api-reference/redteam-api-reference/endpoint/risk-mitigation-system-prompt"},{"openapi":"POST /redteam/risk-mitigation/guardrails-policy","title":"Generate a guardrail and policy for risk mitigation based on summary","href":"/api-reference/redteam-api-reference/endpoint/risk-mitigation-guardrails-policy"},{"title":"List All Tasks","openapi":"GET /redteam/list-tasks","href":"/api-reference/redteam-api-reference/endpoint/list-all-tasks"},{"openapi":"POST /redteam/model-health","title":"Model Health","href":"/api-reference/redteam-api-reference/endpoint/model-health"},{"openapi":"POST /redteam/v2/add-task","title":"Add Task","href":"/api-reference/redteam-api-reference/endpoint/add-task"},{"openapi":"POST /redteam/v2/model/add-task","title":"Add Task with saved model","href":"/api-reference/redteam-api-reference/endpoint/model-add-task"},{"openapi":"POST /redteam/v2/add-custom-task","title":"Add Custom Task","href":"/api-reference/redteam-api-reference/endpoint/add-custom-task"},{"openapi":"POST /redteam/v2/model/add-custom-task","title":"Add Custom Task with saved model","href":"/api-reference/redteam-api-reference/endpoint/model-add-custom-task"}]},{"group":"Leaderboard","pages":[{"openapi":"GET /leaderboard/models-list","title":"v1 Models List","href":"/api-reference/leaderboard-api-reference/endpoint/v1/models/models-list"},{"openapi":"GET /leaderboard/scores","title":"v1 Scores list","href":"/api-reference/leaderboard-api-reference/endpoint/v1/scores/scores-list"},{"openapi":"GET /leaderboard/scores/{modelName}","title":"v1 Model Score","href":"/api-reference/leaderboard-api-reference/endpoint/v1/scores/model-score"},{"openapi":"GET /leaderboard/details/{modelName}","title":"v1 Model Detail","href":"/api-reference/leaderboard-api-reference/endpoint/v1/details/model-detail"},{"openapi":"GET /leaderboard/summary/{modelName}","title":"v1 Model Summary","href":"/api-reference/leaderboard-api-reference/endpoint/v1/summary/model-summary"},{"openapi":"GET /leaderboard/rank/{modelName}","title":"v1 Model Rank","href":"/api-reference/leaderboard-api-reference/endpoint/v1/rank/model-rank"},{"openapi":"GET /leaderboard/percentiles","title":"v1 Models Risk Percentiles","href":"/api-reference/leaderboard-api-reference/endpoint/v1/percentiles/models-risk-percentiles"}]},{"group":"Policy Atomizer (Legacy)","pages":[{"title":"Policy Atomizer","openapi":"POST /guardrails/policy-atomizer","href":"/api-reference/coc-api-reference/endpoint/policy-atomizer"}]}]}]}]},{"tab":"SDK Reference","pages":[{"title":"SDK Reference","href":"/sdk-reference/python/introduction"}]},{"tab":"Schema and Postman","pages":[{"title":"Schema and Postman","href":"/schema-and-postman/introduction"}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/resources/introduction"}]}]},"basePath":"","title":"AI Chat Completions Proxy Endpoint - Enkrypt AI","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}