from portkey_ai import Portkey# Initialize the Portkey clientportkey = Portkey( api_key="PORTKEY_API_KEY",)# Get a specific virtual keyvirtual_key = portkey.virtual_keys.retrieve( slug='VIRTUAL_KEY_SLUG')print(virtual_key)
from portkey_ai import Portkey# Initialize the Portkey clientportkey = Portkey( api_key="PORTKEY_API_KEY",)# Get a specific virtual keyvirtual_key = portkey.virtual_keys.retrieve( slug='VIRTUAL_KEY_SLUG')print(virtual_key)
Portkey is now PRISMA AIRS AI Gateway. See it in action.
Contact Us
Authorizations
x-portkey-api-key
string
header
required
Path Parameters
slug
string
required
Response
200 - application/json
Successful response
id
string<UUID>
organisation_id
string<UUID>
ai_provider_id
string
name
string
status
enum<string>
Available options:
active,
archived
created_at
string<date-time>
last_updated_at
string<date-time> | null
slug
string
description
string
tags
object | null
Key-value tags attached to the integration
Show child attributes
object
enum<string>
Available options:
integration
masked_key
string
Masked API key
configurations
OpenAI · object
Configuration for OpenAI integrations. Supports three authentication modes
selected via provider_auth_type:
apiKey (default) – standard API-key auth; no extra fields required.
oauthClientCredentials – Portkey obtains an access token from your IdP using
the OAuth 2.0 client-credentials grant and forwards it to OpenAI.
wif (Workload Identity Federation) – Portkey mints a subject JWT via your
configured IdP and exchanges it at OpenAI's WIF token endpoint.
OpenAI
Anthropic
Azure OpenAI
AWS Bedrock
Vertex AI
Azure AI
Workers AI
AWS Sagemaker
Hugginface
Cortex
Custom Base URL
Show child attributes
global_workspace_access_settings
object | null
Global workspace access configuration
Show child attributes
allow_all_models
boolean
Whether new models will be enabled by default
workspace_count
integer
Number of workspaces with access to this integration
secret_mappings
object[]
Secret reference mappings for this integration. Valid target_field values are "key" or "configurations.".
Show child attributes
pricing_adjustments
object | null
Per-Integration pricing adjustments applied on top of Portkey's base model pricing
for cost tracking, analytics, and budget limits. Use to reflect negotiated discounts,
committed-use rates, or internal markups for cost showback.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Portkey (Prisma AIRS AI Gateway) Docs","description":"Comprehensive documentation for AI Gateway, Guardrails, Observability, and Governance features.","colors":{"primary":"#0891B2","light":"#0891B2","dark":"#0891B2"},"logo":{"light":"https://mintcdn.com/portkey-docs/tHk-hgNjLbEj4dhh/images/portkey-PANW-company-logo-positive.png?fit=max\u0026auto=format\u0026n=tHk-hgNjLbEj4dhh\u0026q=85\u0026s=c5fb09014ff79616583b1d3bffe27450","dark":"https://mintcdn.com/portkey-docs/tHk-hgNjLbEj4dhh/images/portkey-PANW-company-logo-negative.png?fit=max\u0026auto=format\u0026n=tHk-hgNjLbEj4dhh\u0026q=85\u0026s=6025ca49ef544522f58ff471b7f75f8f"},"favicon":"https://mintcdn.com/portkey-docs/Hf1XgyjG_b79ym4Q/favicon.png?fit=max\u0026auto=format\u0026n=Hf1XgyjG_b79ym4Q\u0026q=85\u0026s=cbaa1bfc49bb6e3fd6cf499a5da313a3","api":{"openapi":"https://raw.githubusercontent.com/Portkey-AI/openapi/refs/heads/master/openapi.yaml","examples":{"prefill":true},"url":"full"},"navbar":{"links":[{"href":"https://portkey.ai/models","label":"Models"},{"href":"https://support.portkey.ai/forms/customer-portal-ticket-form","label":"Support"},{"href":"https://www.paloaltonetworks.in/ai-security/ai-gateway?utm_source=portkey\u0026utm_medium=referral\u0026utm_campaign=prisma_airs\u0026utm_content=docs_nav#contact","label":"Contact Us"}],"primary":{"type":"button","label":"Sign in","href":"https://stratacloudmanager.paloaltonetworks.com/"}},"footer":{"socials":{"x":"https://twitter.com/PortkeyAI","linkedin":"https://www.linkedin.com/company/portkey-ai","github":"https://git.new/portkey"},"links":[{"header":"For LLMs","items":[{"label":"llms.txt","href":"https://portkey.ai/docs/llms.txt"},{"label":"llms-full.txt","href":"https://portkey.ai/docs/llms-full.txt"}]},{"header":"Products","items":[{"label":"Observability","href":"https://portkey.ai/features/observability"},{"label":"AI Gateway","href":"https://portkey.ai/features/ai-gateway"},{"label":"Guardrails","href":"https://portkey.ai/features/guardrails"},{"label":"Prompt Management","href":"https://portkey.ai/features/prompt-management"},{"label":"Agents","href":"https://portkey.ai/features/agents"},{"label":"MCP Gateway","href":"https://portkey.ai/docs/product/mcp-gateway"},{"label":"Security","href":"https://portkey.ai/features/security-and-compliance"},{"label":"Auto-Instrumentation","href":"https://portkey.ai/features/auto-instrumentation"}]},{"header":"Resources","items":[{"label":"API Status","href":"https://status.portkey.ai/"},{"label":"Helm Charts","href":"https://github.com/portkey-ai/helm"},{"label":"AI Grants Finder","href":"https://grantsfinder.portkey.ai/"},{"label":"Events Calendar","href":"https://lu.ma/portkey"},{"label":"Blog","href":"https://portkey.ai/blog"},{"label":"Error Library","href":"https://portkey.ai/error-library"},{"label":"Models \u0026 Pricing","href":"https://portkey.ai/models"}]},{"header":"Company","items":[{"label":"Pricing","href":"https://portkey.ai/pricing"},{"label":"Compliances","href":"https://trust.portkey.ai/"},{"label":"Privacy Policy","href":"https://portkey.ai/privacy-policy"},{"label":"Terms of Service","href":"https://portkey.ai/terms"},{"label":"DPA","href":"https://portkey.ai/dpa"},{"label":"Cookie Policy","href":"https://portkey.ai/cookie-policy"}]}]},"seo":{"metatags":{"og:type":"website","og:site_name":"Portkey AI Gateway Docs"},"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"ga4":{"measurementId":"G-JJMXYE4DRL"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"toc"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"portkey-docs","hasAudioNarration":false,"actualSubdomain":"portkey-docs","customDomains":["docs.portkey.ai","portkey.ai"],"gitSource":{"type":"github","owner":"portkey-ai","repo":"docs-core","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6b0002774462e8babfefabe7","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Integrations","count":699},{"language":"default","tag":"Product","count":389},{"language":"default","tag":"Docs","count":328},{"language":"default","tag":"LLM Integrations","count":307},{"language":"default","tag":"Admin APIs","count":189},{"language":"default","tag":"More","count":176},{"language":"default","tag":"Guardrails","count":102},{"language":"default","tag":"Administration","count":102},{"language":"default","tag":"AI Gateway","count":99},{"language":"default","tag":"Admin API","count":95}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@portkey.ai","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#banner{background:linear-gradient(90deg, #0d1b2e 0%, #1a1040 40%, #2d0f22 100%);border-bottom:1px solid rgba(255, 255, 255, 0.08)}#banner a{color:#f0f0f0;text-decoration:none;font-weight:600;border-bottom:1px solid rgba(240, 240, 240, 0.5);padding-bottom:1px;transition:border-color 0.2s ease}#banner a:hover{border-bottom-color:#ffffff}"}]}
{"page":{"pagePath":"api-reference/admin-api/control-plane/integrations/retrieve-integration","slug":"/api-reference/admin-api/control-plane/integrations/retrieve-integration","pageMetadata":{"title":"Retrieve Integration","openapi":"get /integrations/{slug}","description":"","href":"/api-reference/admin-api/control-plane/integrations/retrieve-integration"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={hr:`hr`,p:`p`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsxs(_Fragment,{children:[_jsx(_components.hr,{}),`\n`,_jsx(Card,{title:`Portkey is now PRISMA AIRS AI Gateway. See it in action.`,href:`https://www.paloaltonetworks.in/ai-security/ai-gateway?utm_source=portkey\u0026utm_medium=referral\u0026utm_campaign=prisma_airs\u0026utm_content=docs_nav#contact`,icon:`arrow-up-right-from-square`,children:_jsx(_components.p,{children:`Contact Us`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Retrieve Integration","openapi":"get /integrations/{slug}","description":"","href":"/api-reference/admin-api/control-plane/integrations/retrieve-integration"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get a Integration","tags":["Integrations"],"parameters":["cef16c34-9a4a-47b1-8160-88204d6a5025"],"responses":{"200":"74ddce42-d97d-439d-b4e3-0fe948799659"},"x-code-samples":[{"lang":"python","label":"Default","source":"from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n api_key=\"PORTKEY_API_KEY\",\n)\n\n# Get a specific virtual key\nvirtual_key = portkey.virtual_keys.retrieve(\n slug='VIRTUAL_KEY_SLUG'\n)\n\nprint(virtual_key)\n"},{"lang":"javascript","label":"Default","source":"import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n apiKey: \"PORTKEY_API_KEY\",\n})\n\nconst vKey=await portkey.virtualKeys.retrieve({\n slug:'VIRTUAL_KEY_SLUG'\n})\nconsole.log(vKey);\n"},{"lang":"curl","label":"Default","source":"curl -X GET https://api.portkey.ai/v1/virtual-keys/VIRTUAL_KEY_SLUG \\\n-H \"x-portkey-api-key: PORTKEY_API_KEY\"\n"},{"lang":"curl","label":"Self-Hosted","source":"curl -X GET SELF_HOSTED_CONTROL_PLANE_URL/virtual-keys/VIRTUAL_KEY_SLUG \\\n-H \"x-portkey-api-key: PORTKEY_API_KEY\"\n"},{"lang":"python","label":"Self-Hosted","source":"from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n api_key=\"PORTKEY_API_KEY\",\n base_url=\"SELF_HOSTED_CONTROL_PLANE_URL\"\n)\n\n# Get a specific virtual key\nvirtual_key = portkey.virtual_keys.retrieve(\n slug='VIRTUAL_KEY_SLUG'\n)\n\nprint(virtual_key)\n"},{"lang":"javascript","label":"Self-Hosted","source":"import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n apiKey: \"PORTKEY_API_KEY\",\n baseUrl: \"SELF_HOSTED_CONTROL_PLANE_URL\"\n})\n\nconst vKey=await portkey.virtualKeys.retrieve({\n slug:'VIRTUAL_KEY_SLUG'\n})\nconsole.log(vKey);\n"}],"method":"get","type":"path","servers":["8764b1a7-5267-4a5b-8408-9784f63bb043","c1e92644-752d-440e-a764-db569a62980a"],"security":["8921f4af-dcc2-4019-92de-fba18beb8448"],"path":"/integrations/{slug}","baseUrlOptions":["https://api.portkey.ai/v1","SELF_HOSTED_CONTROL_PLANE_URL"],"title":"Get a Integration","description":"","codeSamples":[{"label":"Default","lang":"python","source":"from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n api_key=\"PORTKEY_API_KEY\",\n)\n\n# Get a specific virtual key\nvirtual_key = portkey.virtual_keys.retrieve(\n slug='VIRTUAL_KEY_SLUG'\n)\n\nprint(virtual_key)\n"},{"label":"Default","lang":"javascript","source":"import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n apiKey: \"PORTKEY_API_KEY\",\n})\n\nconst vKey=await portkey.virtualKeys.retrieve({\n slug:'VIRTUAL_KEY_SLUG'\n})\nconsole.log(vKey);\n"},{"label":"Default","lang":"curl","source":"curl -X GET https://api.portkey.ai/v1/virtual-keys/VIRTUAL_KEY_SLUG \\\n-H \"x-portkey-api-key: PORTKEY_API_KEY\"\n"},{"label":"Self-Hosted","lang":"curl","source":"curl -X GET SELF_HOSTED_CONTROL_PLANE_URL/virtual-keys/VIRTUAL_KEY_SLUG \\\n-H \"x-portkey-api-key: PORTKEY_API_KEY\"\n"},{"label":"Self-Hosted","lang":"python","source":"from portkey_ai import Portkey\n\n# Initialize the Portkey client\nportkey = Portkey(\n api_key=\"PORTKEY_API_KEY\",\n base_url=\"SELF_HOSTED_CONTROL_PLANE_URL\"\n)\n\n# Get a specific virtual key\nvirtual_key = portkey.virtual_keys.retrieve(\n slug='VIRTUAL_KEY_SLUG'\n)\n\nprint(virtual_key)\n"},{"label":"Self-Hosted","lang":"javascript","source":"import { Portkey } from \"portkey-ai\";\n\nconst portkey = new Portkey({\n apiKey: \"PORTKEY_API_KEY\",\n baseUrl: \"SELF_HOSTED_CONTROL_PLANE_URL\"\n})\n\nconst vKey=await portkey.virtualKeys.retrieve({\n slug:'VIRTUAL_KEY_SLUG'\n})\nconsole.log(vKey);\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"cef16c34-9a4a-47b1-8160-88204d6a5025":{"name":"slug","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"74ddce42-d97d-439d-b4e3-0fe948799659":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"UUID","uniqueKey":"id","typeLabel":"string\u003cUUID>"},"organisation_id":{"type":"string","format":"UUID","uniqueKey":"organisation_id","typeLabel":"string\u003cUUID>"},"ai_provider_id":{"type":"string","uniqueKey":"ai_provider_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","enum":["active","archived"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"last_updated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"last_updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"last_updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_updated_at","typeLabel":"string\u003cdate-time> | null"},"slug":{"type":"string","uniqueKey":"slug","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"tags":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"tags.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Key-value tags attached to the integration","uniqueKey":"tags.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"tags.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Key-value tags attached to the integration","uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"object | null"},"object":{"type":"string","enum":["integration"],"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"masked_key":{"type":"string","description":"Masked API key","uniqueKey":"masked_key","typeLabel":"string"},"configurations":{"oneOf":[{"type":"object","title":"OpenAI","description":"Configuration for OpenAI integrations. Supports three authentication modes\nselected via `provider_auth_type`:\n- **apiKey** (default) – standard API-key auth; no extra fields required.\n- **oauthClientCredentials** – Portkey obtains an access token from your IdP using\n the OAuth 2.0 client-credentials grant and forwards it to OpenAI.\n- **wif** (Workload Identity Federation) – Portkey mints a subject JWT via your\n configured IdP and exchanges it at OpenAI's WIF token endpoint.\n","properties":{"provider_auth_type":{"type":"string","enum":["apiKey","oauthClientCredentials","wif"],"default":"apiKey","description":"Authentication mode for the OpenAI integration","uniqueKey":"configurations.oneOf.0.provider_auth_type","typeLabel":"enum\u003cstring>"},"openai_organization":{"type":"string","description":"OpenAI organization ID","uniqueKey":"configurations.oneOf.0.openai_organization","typeLabel":"string"},"openai_project":{"type":"string","description":"OpenAI project ID","uniqueKey":"configurations.oneOf.0.openai_project","typeLabel":"string"},"oauth_token_endpoint":{"type":"string","description":"Token endpoint URL of your identity provider (required for oauthClientCredentials and wif auth)","uniqueKey":"configurations.oneOf.0.oauth_token_endpoint","typeLabel":"string"},"oauth_client_id":{"type":"string","description":"OAuth client ID issued by your IdP (required for oauthClientCredentials and wif auth)","uniqueKey":"configurations.oneOf.0.oauth_client_id","typeLabel":"string"},"oauth_client_secret":{"type":"string","description":"OAuth client secret (required for oauthClientCredentials and wif auth)","uniqueKey":"configurations.oneOf.0.oauth_client_secret","typeLabel":"string"},"oauth_scope":{"type":"string","description":"OAuth scope to request (optional)","uniqueKey":"configurations.oneOf.0.oauth_scope","typeLabel":"string"},"wif_identity_source":{"type":"string","enum":["configuredIdp"],"default":"configuredIdp","description":"Source of the subject JWT for WIF exchange (only configuredIdp is supported today)","uniqueKey":"configurations.oneOf.0.wif_identity_source","typeLabel":"enum\u003cstring>"},"oauth_audience":{"type":"string","description":"Audience claim for the subject JWT (optional, wif only)","uniqueKey":"configurations.oneOf.0.oauth_audience","typeLabel":"string"},"openai_identity_provider_id":{"type":"string","description":"OpenAI identity provider ID (required for wif auth)","uniqueKey":"configurations.oneOf.0.openai_identity_provider_id","typeLabel":"string"},"openai_service_account_id":{"type":"string","description":"OpenAI service account ID (required for wif auth)","uniqueKey":"configurations.oneOf.0.openai_service_account_id","typeLabel":"string"},"is_key_required":{"type":"boolean","default":true,"description":"Whether an API key is still required. Set to false for oauthClientCredentials and wif auth.","uniqueKey":"configurations.oneOf.0.is_key_required","typeLabel":"boolean"}},"uniqueKey":"configurations.oneOf.0","typeLabel":"OpenAI · object"},{"type":"object","title":"Anthropic","description":"Configuration for Anthropic integrations. Supports two authentication modes\nselected via `provider_auth_type`:\n- **apiKey** (default) – standard API-key auth; no extra fields required.\n- **wif** (Workload Identity Federation) – Portkey mints a subject JWT via your\n configured IdP and exchanges it at Anthropic's WIF token endpoint.\n","properties":{"provider_auth_type":{"type":"string","enum":["apiKey","wif"],"default":"apiKey","description":"Authentication mode for the Anthropic integration","uniqueKey":"configurations.oneOf.1.provider_auth_type","typeLabel":"enum\u003cstring>"},"anthropic_inspect_stream_for_overloaded_error":{"type":"boolean","description":"Enable inspection of streaming responses for overloaded errors","uniqueKey":"configurations.oneOf.1.anthropic_inspect_stream_for_overloaded_error","typeLabel":"boolean"},"oauth_token_endpoint":{"type":"string","description":"Token endpoint URL of your identity provider (required for wif auth)","uniqueKey":"configurations.oneOf.1.oauth_token_endpoint","typeLabel":"string"},"oauth_client_id":{"type":"string","description":"OAuth client ID issued by your IdP (required for wif auth)","uniqueKey":"configurations.oneOf.1.oauth_client_id","typeLabel":"string"},"oauth_client_secret":{"type":"string","description":"OAuth client secret (required for wif auth)","uniqueKey":"configurations.oneOf.1.oauth_client_secret","typeLabel":"string"},"oauth_scope":{"type":"string","description":"OAuth scope to request (optional)","uniqueKey":"configurations.oneOf.1.oauth_scope","typeLabel":"string"},"wif_identity_source":{"type":"string","enum":["configuredIdp"],"default":"configuredIdp","description":"Source of the subject JWT for WIF exchange","uniqueKey":"configurations.oneOf.1.wif_identity_source","typeLabel":"enum\u003cstring>"},"oauth_audience":{"type":"string","description":"Audience claim for the subject JWT (optional)","uniqueKey":"configurations.oneOf.1.oauth_audience","typeLabel":"string"},"anthropic_federation_rule_id":{"type":"string","description":"Anthropic federation rule ID (required for wif auth)","uniqueKey":"configurations.oneOf.1.anthropic_federation_rule_id","typeLabel":"string"},"anthropic_organization_id":{"type":"string","description":"Anthropic organization ID (required for wif auth)","uniqueKey":"configurations.oneOf.1.anthropic_organization_id","typeLabel":"string"},"anthropic_service_account_id":{"type":"string","description":"Anthropic service account ID (required for wif auth)","uniqueKey":"configurations.oneOf.1.anthropic_service_account_id","typeLabel":"string"},"anthropic_workspace_id":{"type":"string","description":"Anthropic workspace ID (optional, for wif auth)","uniqueKey":"configurations.oneOf.1.anthropic_workspace_id","typeLabel":"string"},"is_key_required":{"type":"boolean","default":true,"description":"Whether an API key is still required. Set to false for wif auth.","uniqueKey":"configurations.oneOf.1.is_key_required","typeLabel":"boolean"}},"uniqueKey":"configurations.oneOf.1","typeLabel":"Anthropic · object"},{"type":"object","title":"Azure OpenAI","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","required":["azure_resource_name","azure_deployment_config","azure_auth_mode"],"properties":{"azure_auth_mode":{"type":"string","enum":["default","entra","managed"],"description":"Authentication mode for Azure","isRequired":true,"uniqueKey":"configurations.oneOf.2.azure_auth_mode","typeLabel":"enum\u003cstring>"},"azure_resource_name":{"type":"string","description":"Azure OpenAI resource name","isRequired":true,"uniqueKey":"configurations.oneOf.2.azure_resource_name","typeLabel":"string"},"azure_deployment_config":{"type":"array","minItems":1,"items":{"type":"object","required":["azure_api_version","azure_deployment_name","azure_model_slug"],"properties":{"azure_api_version":{"type":"string","maxLength":30,"description":"Azure API version","isRequired":true,"uniqueKey":"configurations.oneOf.2.azure_deployment_config.items.[INDEX].azure_api_version","typeLabel":"string"},"azure_deployment_name":{"type":"string","description":"Azure deployment name","isRequired":true,"uniqueKey":"configurations.oneOf.2.azure_deployment_config.items.[INDEX].azure_deployment_name","typeLabel":"string"},"azure_model_slug":{"type":"string","description":"Azure model slug","isRequired":true,"uniqueKey":"configurations.oneOf.2.azure_deployment_config.items.[INDEX].azure_model_slug","typeLabel":"string"},"alias":{"type":"string","description":"Alias for the deployment","uniqueKey":"configurations.oneOf.2.azure_deployment_config.items.[INDEX].alias","typeLabel":"string"},"is_default":{"type":"boolean","default":false,"description":"Whether this is the default deployment","uniqueKey":"configurations.oneOf.2.azure_deployment_config.items.[INDEX].is_default","typeLabel":"boolean"}},"uniqueKey":"configurations.oneOf.2.azure_deployment_config.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"configurations.oneOf.2.azure_deployment_config","typeLabel":"object[]"},"azure_entra_tenant_id":{"type":"string","description":"Azure AD tenant ID (required for entra auth)","uniqueKey":"configurations.oneOf.2.azure_entra_tenant_id","typeLabel":"string"},"azure_entra_client_id":{"type":"string","description":"Azure AD client ID (required for entra auth)","uniqueKey":"configurations.oneOf.2.azure_entra_client_id","typeLabel":"string"},"azure_entra_client_secret":{"type":"string","description":"Azure AD client secret (required for entra auth)","uniqueKey":"configurations.oneOf.2.azure_entra_client_secret","typeLabel":"string"},"azure_managed_client_id":{"type":"string","description":"Managed identity client ID (optional for managed auth)","uniqueKey":"configurations.oneOf.2.azure_managed_client_id","typeLabel":"string"}},"uniqueKey":"configurations.oneOf.2","typeLabel":"Azure OpenAI · object"},{"type":"object","title":"AWS Bedrock","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","required":["aws_auth_type","aws_region"],"properties":{"aws_auth_type":{"type":"string","enum":["accessKey","assumedRole"],"description":"AWS authentication type","isRequired":true,"uniqueKey":"configurations.oneOf.3.aws_auth_type","typeLabel":"enum\u003cstring>"},"aws_region":{"type":"string","description":"AWS region","isRequired":true,"uniqueKey":"configurations.oneOf.3.aws_region","typeLabel":"string"},"aws_access_key_id":{"type":"string","description":"AWS access key ID (required for accessKey auth)","uniqueKey":"configurations.oneOf.3.aws_access_key_id","typeLabel":"string"},"aws_secret_access_key":{"type":"string","description":"AWS secret access key (required for accessKey auth)","uniqueKey":"configurations.oneOf.3.aws_secret_access_key","typeLabel":"string"},"aws_role_arn":{"type":"string","description":"AWS role ARN (required for assumedRole auth)","uniqueKey":"configurations.oneOf.3.aws_role_arn","typeLabel":"string"},"aws_external_id":{"oneOf":[{"type":"string","description":"AWS external ID (optional for assumedRole auth)","uniqueKey":"configurations.oneOf.3.aws_external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"AWS external ID (optional for assumedRole auth)","uniqueKey":"configurations.oneOf.3.aws_external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"configurations.oneOf.3.aws_external_id","typeLabel":"string | null"}},"uniqueKey":"configurations.oneOf.3","typeLabel":"AWS Bedrock · object"},{"type":"object","title":"Vertex AI","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","required":["vertex_auth_type","vertex_region"],"properties":{"vertex_auth_type":{"type":"string","enum":["basic","serviceAccount"],"description":"Vertex AI authentication type","isRequired":true,"uniqueKey":"configurations.oneOf.4.vertex_auth_type","typeLabel":"enum\u003cstring>"},"vertex_region":{"type":"string","description":"GCP region","isRequired":true,"uniqueKey":"configurations.oneOf.4.vertex_region","typeLabel":"string"},"vertex_project_id":{"type":"string","description":"GCP project ID (required for basic auth)","uniqueKey":"configurations.oneOf.4.vertex_project_id","typeLabel":"string"},"vertex_service_account_json":{"type":"object","description":"Service account JSON (required for serviceAccount auth)","uniqueKey":"configurations.oneOf.4.vertex_service_account_json","typeLabel":"object"}},"uniqueKey":"configurations.oneOf.4","typeLabel":"Vertex AI · object"},{"type":"object","title":"Azure AI","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","required":["azure_foundry_url","azure_auth_mode"],"properties":{"azure_auth_mode":{"type":"string","enum":["default","entra","managed"],"description":"Authentication mode for Azure AI","isRequired":true,"uniqueKey":"configurations.oneOf.5.azure_auth_mode","typeLabel":"enum\u003cstring>"},"azure_foundry_url":{"type":"string","description":"Azure AI Foundry URL","isRequired":true,"uniqueKey":"configurations.oneOf.5.azure_foundry_url","typeLabel":"string"},"azure_api_version":{"type":"string","maxLength":30,"description":"Azure API version","uniqueKey":"configurations.oneOf.5.azure_api_version","typeLabel":"string"},"azure_deployment_name":{"type":"string","description":"Azure deployment name","uniqueKey":"configurations.oneOf.5.azure_deployment_name","typeLabel":"string"},"azure_entra_tenant_id":{"type":"string","description":"Azure AD tenant ID (required for entra auth)","uniqueKey":"configurations.oneOf.5.azure_entra_tenant_id","typeLabel":"string"},"azure_entra_client_id":{"type":"string","description":"Azure AD client ID (required for entra auth)","uniqueKey":"configurations.oneOf.5.azure_entra_client_id","typeLabel":"string"},"azure_entra_client_secret":{"type":"string","description":"Azure AD client secret (required for entra auth)","uniqueKey":"configurations.oneOf.5.azure_entra_client_secret","typeLabel":"string"},"azure_managed_client_id":{"type":"string","description":"Managed identity client ID (optional for managed auth)","uniqueKey":"configurations.oneOf.5.azure_managed_client_id","typeLabel":"string"}},"uniqueKey":"configurations.oneOf.5","typeLabel":"Azure AI · object"},{"type":"object","title":"Workers AI","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","required":["workers_ai_account_id"],"properties":{"workers_ai_account_id":{"type":"string","description":"Cloudflare Workers AI account ID","isRequired":true,"uniqueKey":"configurations.oneOf.6.workers_ai_account_id","typeLabel":"string"}},"uniqueKey":"configurations.oneOf.6","typeLabel":"Workers AI · object"},{"type":"object","title":"AWS Sagemaker","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","required":["aws_auth_type","aws_region"],"properties":{"aws_auth_type":{"type":"string","enum":["accessKey","assumedRole"],"description":"AWS authentication type","isRequired":true,"uniqueKey":"configurations.oneOf.7.aws_auth_type","typeLabel":"enum\u003cstring>"},"aws_region":{"type":"string","description":"AWS region","isRequired":true,"uniqueKey":"configurations.oneOf.7.aws_region","typeLabel":"string"},"aws_access_key_id":{"type":"string","description":"AWS access key ID (required for accessKey auth)","uniqueKey":"configurations.oneOf.7.aws_access_key_id","typeLabel":"string"},"aws_secret_access_key":{"type":"string","description":"AWS secret access key (required for accessKey auth)","uniqueKey":"configurations.oneOf.7.aws_secret_access_key","typeLabel":"string"},"aws_role_arn":{"type":"string","description":"AWS role ARN (required for assumedRole auth)","uniqueKey":"configurations.oneOf.7.aws_role_arn","typeLabel":"string"},"aws_external_id":{"oneOf":[{"type":"string","description":"AWS external ID (optional for assumedRole auth)","uniqueKey":"configurations.oneOf.7.aws_external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"AWS external ID (optional for assumedRole auth)","uniqueKey":"configurations.oneOf.7.aws_external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"configurations.oneOf.7.aws_external_id","typeLabel":"string | null"},"amzn_sagemaker_custom_attributes":{"type":"string","description":"Custom attributes for SageMaker","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_custom_attributes","typeLabel":"string"},"amzn_sagemaker_target_model":{"type":"string","description":"Target model for SageMaker","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_target_model","typeLabel":"string"},"amzn_sagemaker_target_variant":{"type":"string","description":"Target variant for SageMaker","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_target_variant","typeLabel":"string"},"amzn_sagemaker_target_container_hostname":{"type":"string","description":"Target container hostname","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_target_container_hostname","typeLabel":"string"},"amzn_sagemaker_inference_id":{"type":"string","description":"Inference ID","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_inference_id","typeLabel":"string"},"amzn_sagemaker_enable_explanations":{"type":"string","description":"Enable explanations","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_enable_explanations","typeLabel":"string"},"amzn_sagemaker_inference_component":{"type":"string","description":"Inference component","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_inference_component","typeLabel":"string"},"amzn_sagemaker_session_id":{"type":"string","description":"Session ID","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_session_id","typeLabel":"string"},"amzn_sagemaker_model_name":{"type":"string","description":"Model name","uniqueKey":"configurations.oneOf.7.amzn_sagemaker_model_name","typeLabel":"string"}},"uniqueKey":"configurations.oneOf.7","typeLabel":"AWS Sagemaker · object"},{"type":"object","title":"Hugginface","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","properties":{"huggingface_base_url":{"type":"string","description":"Custom Hugging Face base URL","uniqueKey":"configurations.oneOf.8.huggingface_base_url","typeLabel":"string"}},"uniqueKey":"configurations.oneOf.8","typeLabel":"Hugginface · object"},{"type":"object","title":"Cortex","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","required":["snowflake_account"],"properties":{"snowflake_account":{"type":"string","description":"Snowflake account identifier","isRequired":true,"uniqueKey":"configurations.oneOf.9.snowflake_account","typeLabel":"string"}},"uniqueKey":"configurations.oneOf.9","typeLabel":"Cortex · object"},{"type":"object","title":"Custom Base URL","description":"Provider-specific configuration object\n\n**⚠️ Security Note - Response Masking:**\nWhen retrieving integration details, sensitive fields are automatically masked:\n- Sensitive fields get a `masked_` prefix (e.g., `client_secret` → `masked_client_secret`)\n- Non-sensitive fields (IDs, URLs, regions, etc.) remain unchanged\n","properties":{"custom_host":{"type":"string","description":"Custom host URL (can be used along with other provider specific configuration fields)","uniqueKey":"configurations.oneOf.10.custom_host","typeLabel":"string"},"custom_headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"configurations.oneOf.10.custom_headers.additionalProperties","typeLabel":"string"},"description":"Custom headers to send with requests (can be used along with other provider specific configuration fields)","uniqueKey":"configurations.oneOf.10.custom_headers","typeLabel":"object"}},"uniqueKey":"configurations.oneOf.10","typeLabel":"Custom Base URL · object"}],"uniqueKey":"configurations","typeLabel":"OpenAI · object | Anthropic · object | Azure OpenAI · object | AWS Bedrock · object | Vertex AI · object | Azure AI · object | Workers AI · object | AWS Sagemaker · object | Hugginface · object | Cortex · object | Custom Base URL · object"},"global_workspace_access_settings":{"oneOf":[{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether global workspace access is enabled. When enabled, the integration will be enabled for all workspaces that are created in future.","isRequired":true,"uniqueKey":"global_workspace_access_settings.oneOf.0.enabled","typeLabel":"boolean"},"usage_limits":{"oneOf":[{"type":"array","maxItems":1,"items":{"type":"object","properties":{"credit_limit":{"type":"integer","description":"Credit Limit. Used for tracking usage","minimum":1,"default":null,"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].credit_limit","typeLabel":"integer"},"type":{"type":"string","description":"Type of credit limit","enum":["cost","tokens"],"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"alert_threshold":{"type":"integer","description":"Alert Threshold. Used for alerting when usage reaches more than this","minimum":1,"default":null,"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].alert_threshold","typeLabel":"integer"},"periodic_reset":{"oneOf":[{"type":"string","description":"Reset the usage periodically.","enum":["monthly","weekly"],"example":"monthly","uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].periodic_reset.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Reset the usage periodically.","enum":["monthly","weekly"],"example":"monthly","uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].periodic_reset.oneOf.1","typeLabel":"null"}],"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].periodic_reset","typeLabel":"enum\u003cstring> | null"},"periodic_reset_days":{"oneOf":[{"type":"integer","description":"Reset the usage counter every N days (1-365). Mutually exclusive with periodic_reset.","minimum":1,"maximum":365,"example":30,"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].periodic_reset_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Reset the usage counter every N days (1-365). Mutually exclusive with periodic_reset.","minimum":1,"maximum":365,"example":30,"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].periodic_reset_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].periodic_reset_days","typeLabel":"integer | null"},"next_usage_reset_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 datetime for the next scheduled usage reset. Auto-computed from periodic_reset or periodic_reset_days if not provided.","example":"2026-05-01T00:00:00Z","uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].next_usage_reset_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 datetime for the next scheduled usage reset. Auto-computed from periodic_reset or periodic_reset_days if not provided.","example":"2026-05-01T00:00:00Z","uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].next_usage_reset_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX].next_usage_reset_at","typeLabel":"string\u003cdate-time> | null"}},"example":{"credit_limit":10,"periodic_reset":"monthly","alert_threshold":8},"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.0","typeLabel":"object[]"},{"type":"null","maxItems":1,"items":{"type":"object","properties":{"credit_limit":{"type":"integer","description":"Credit Limit. Used for tracking usage","minimum":1,"default":null},"type":{"type":"string","description":"Type of credit limit","enum":["cost","tokens"]},"alert_threshold":{"type":"integer","description":"Alert Threshold. Used for alerting when usage reaches more than this","minimum":1,"default":null},"periodic_reset":{"oneOf":[{"type":"string","description":"Reset the usage periodically.","enum":["monthly","weekly"],"example":"monthly"},{"type":"null","description":"Reset the usage periodically.","enum":["monthly","weekly"],"example":"monthly"}]},"periodic_reset_days":{"oneOf":[{"type":"integer","description":"Reset the usage counter every N days (1-365). Mutually exclusive with periodic_reset.","minimum":1,"maximum":365,"example":30},{"type":"null","description":"Reset the usage counter every N days (1-365). Mutually exclusive with periodic_reset.","minimum":1,"maximum":365,"example":30}]},"next_usage_reset_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 datetime for the next scheduled usage reset. Auto-computed from periodic_reset or periodic_reset_days if not provided.","example":"2026-05-01T00:00:00Z"},{"type":"null","format":"date-time","description":"ISO 8601 datetime for the next scheduled usage reset. Auto-computed from periodic_reset or periodic_reset_days if not provided.","example":"2026-05-01T00:00:00Z"}]}},"example":{"credit_limit":10,"periodic_reset":"monthly","alert_threshold":8}},"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits.oneOf.1","typeLabel":"null"}],"uniqueKey":"global_workspace_access_settings.oneOf.0.usage_limits","typeLabel":"object[] | null"},"rate_limits":{"oneOf":[{"type":"array","maxItems":1,"items":{"type":"object","properties":{"type":{"type":"string","enum":["requests","tokens"],"uniqueKey":"global_workspace_access_settings.oneOf.0.rate_limits.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"unit":{"type":"string","enum":["rpd","rph","rpm"],"uniqueKey":"global_workspace_access_settings.oneOf.0.rate_limits.oneOf.0.items.[INDEX].unit","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","uniqueKey":"global_workspace_access_settings.oneOf.0.rate_limits.oneOf.0.items.[INDEX].value","typeLabel":"integer"}},"uniqueKey":"global_workspace_access_settings.oneOf.0.rate_limits.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"global_workspace_access_settings.oneOf.0.rate_limits.oneOf.0","typeLabel":"object[]"},{"type":"null","maxItems":1,"items":{"type":"object","properties":{"type":{"type":"string","enum":["requests","tokens"]},"unit":{"type":"string","enum":["rpd","rph","rpm"]},"value":{"type":"integer"}}},"uniqueKey":"global_workspace_access_settings.oneOf.0.rate_limits.oneOf.1","typeLabel":"null"}],"uniqueKey":"global_workspace_access_settings.oneOf.0.rate_limits","typeLabel":"object[] | null"}},"description":"Global workspace access configuration","uniqueKey":"global_workspace_access_settings.oneOf.0","typeLabel":"object"},{"type":"null","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether global workspace access is enabled. When enabled, the integration will be enabled for all workspaces that are created in future."},"usage_limits":{"oneOf":[{"type":"array","maxItems":1,"items":{"type":"object","properties":{"credit_limit":{"type":"integer","description":"Credit Limit. Used for tracking usage","minimum":1,"default":null},"type":{"type":"string","description":"Type of credit limit","enum":["cost","tokens"]},"alert_threshold":{"type":"integer","description":"Alert Threshold. Used for alerting when usage reaches more than this","minimum":1,"default":null},"periodic_reset":{"oneOf":[{"type":"string","description":"Reset the usage periodically.","enum":["monthly","weekly"],"example":"monthly"},{"type":"null","description":"Reset the usage periodically.","enum":["monthly","weekly"],"example":"monthly"}]},"periodic_reset_days":{"oneOf":[{"type":"integer","description":"Reset the usage counter every N days (1-365). Mutually exclusive with periodic_reset.","minimum":1,"maximum":365,"example":30},{"type":"null","description":"Reset the usage counter every N days (1-365). Mutually exclusive with periodic_reset.","minimum":1,"maximum":365,"example":30}]},"next_usage_reset_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 datetime for the next scheduled usage reset. Auto-computed from periodic_reset or periodic_reset_days if not provided.","example":"2026-05-01T00:00:00Z"},{"type":"null","format":"date-time","description":"ISO 8601 datetime for the next scheduled usage reset. Auto-computed from periodic_reset or periodic_reset_days if not provided.","example":"2026-05-01T00:00:00Z"}]}},"example":{"credit_limit":10,"periodic_reset":"monthly","alert_threshold":8}}},{"type":"null","maxItems":1,"items":{"type":"object","properties":{"credit_limit":{"type":"integer","description":"Credit Limit. Used for tracking usage","minimum":1,"default":null},"type":{"type":"string","description":"Type of credit limit","enum":["cost","tokens"]},"alert_threshold":{"type":"integer","description":"Alert Threshold. Used for alerting when usage reaches more than this","minimum":1,"default":null},"periodic_reset":{"oneOf":[{"type":"string","description":"Reset the usage periodically.","enum":["monthly","weekly"],"example":"monthly"},{"type":"null","description":"Reset the usage periodically.","enum":["monthly","weekly"],"example":"monthly"}]},"periodic_reset_days":{"oneOf":[{"type":"integer","description":"Reset the usage counter every N days (1-365). Mutually exclusive with periodic_reset.","minimum":1,"maximum":365,"example":30},{"type":"null","description":"Reset the usage counter every N days (1-365). Mutually exclusive with periodic_reset.","minimum":1,"maximum":365,"example":30}]},"next_usage_reset_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 datetime for the next scheduled usage reset. Auto-computed from periodic_reset or periodic_reset_days if not provided.","example":"2026-05-01T00:00:00Z"},{"type":"null","format":"date-time","description":"ISO 8601 datetime for the next scheduled usage reset. Auto-computed from periodic_reset or periodic_reset_days if not provided.","example":"2026-05-01T00:00:00Z"}]}},"example":{"credit_limit":10,"periodic_reset":"monthly","alert_threshold":8}}}]},"rate_limits":{"oneOf":[{"type":"array","maxItems":1,"items":{"type":"object","properties":{"type":{"type":"string","enum":["requests","tokens"]},"unit":{"type":"string","enum":["rpd","rph","rpm"]},"value":{"type":"integer"}}}},{"type":"null","maxItems":1,"items":{"type":"object","properties":{"type":{"type":"string","enum":["requests","tokens"]},"unit":{"type":"string","enum":["rpd","rph","rpm"]},"value":{"type":"integer"}}}}]}},"description":"Global workspace access configuration","uniqueKey":"global_workspace_access_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"global_workspace_access_settings","typeLabel":"object | null"},"allow_all_models":{"type":"boolean","description":"Whether new models will be enabled by default","uniqueKey":"allow_all_models","typeLabel":"boolean"},"workspace_count":{"type":"integer","description":"Number of workspaces with access to this integration","uniqueKey":"workspace_count","typeLabel":"integer"},"secret_mappings":{"type":"array","items":{"type":"object","required":["target_field","secret_reference_id"],"properties":{"target_field":{"type":"string","description":"The field on the entity to populate from the secret reference. Must be unique within the array.\n- **Integrations**: `key` or `configurations.\u003cfield>` (e.g. `configurations.aws_secret_access_key`)\n- **Virtual Keys**: `key` or `model_config.\u003cfield>` (e.g. `model_config.awsSecretAccessKey`)\n- **MCP Integrations**: `configurations.\u003cfield>` (e.g. `configurations.oauth_metadata`)\n","example":"key","isRequired":true,"uniqueKey":"secret_mappings.items.[INDEX].target_field","typeLabel":"string"},"secret_reference_id":{"type":"string","description":"UUID or slug of the secret reference. Must belong to the same organisation and be accessible by the workspace.","example":"my-aws-secret","isRequired":true,"uniqueKey":"secret_mappings.items.[INDEX].secret_reference_id","typeLabel":"string"},"secret_key":{"oneOf":[{"type":"string","description":"Override the secret_key defined on the secret reference. Use to pick a specific key from a multi-value secret.","uniqueKey":"secret_mappings.items.[INDEX].secret_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Override the secret_key defined on the secret reference. Use to pick a specific key from a multi-value secret.","uniqueKey":"secret_mappings.items.[INDEX].secret_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"secret_mappings.items.[INDEX].secret_key","typeLabel":"string | null"},"value_format":{"oneOf":[{"type":"string","enum":["json","string"],"description":"Format of the secret value.\n- `string`: The secret value is treated as a plain string.\n- `json`: The secret value is parsed as JSON before being applied to the target field. Use this when the target field expects a structured object (e.g. `configurations.oauth_metadata`).\n","example":"json","uniqueKey":"secret_mappings.items.[INDEX].value_format.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["json","string"],"description":"Format of the secret value.\n- `string`: The secret value is treated as a plain string.\n- `json`: The secret value is parsed as JSON before being applied to the target field. Use this when the target field expects a structured object (e.g. `configurations.oauth_metadata`).\n","example":"json","uniqueKey":"secret_mappings.items.[INDEX].value_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"secret_mappings.items.[INDEX].value_format","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"secret_mappings.items.[INDEX]","typeLabel":"object"},"description":"Secret reference mappings for this integration. Valid target_field values are \"key\" or \"configurations.\u003cfield>\".","uniqueKey":"secret_mappings","typeLabel":"object[]"},"pricing_adjustments":{"oneOf":[{"type":"object","additionalProperties":false,"description":"Per-Integration pricing adjustments applied on top of Portkey's base model pricing\nfor cost tracking, analytics, and budget limits. Use to reflect negotiated discounts,\ncommitted-use rates, or internal markups for cost showback.\n","properties":{"multiplier":{"type":"object","additionalProperties":false,"description":"Multipliers applied to the corresponding pricing keys from\n[Portkey Models](https://portkey.ai/models). A multiplier of `1` leaves pricing\nunchanged, `0.8` applies a 20% discount, `1.2` applies a 20% markup. Missing or\n`null` fields inherit from `default`; if `default` is also unset, no change is applied.\nAll values must be non-negative numbers.\n","properties":{"default":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier applied to every token type unless a more specific multiplier is set.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.default.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier applied to every token type unless a more specific multiplier is set.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.default","typeLabel":"number | null"},"request_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for input/request token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for input/request token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_token","typeLabel":"number | null"},"response_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for output/response token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for output/response token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_token","typeLabel":"number | null"},"cache_read_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-read input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_input_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for cache-read input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_input_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_input_token","typeLabel":"number | null"},"cache_write_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-write input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_input_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for cache-write input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_input_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_input_token","typeLabel":"number | null"},"cache_read_audio_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-read audio input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_audio_input_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for cache-read audio input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_audio_input_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_audio_input_token","typeLabel":"number | null"},"request_audio_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for audio input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_audio_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for audio input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_audio_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_audio_token","typeLabel":"number | null"},"response_audio_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for audio output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_audio_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for audio output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_audio_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_audio_token","typeLabel":"number | null"},"reasoning_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for reasoning/thinking token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.reasoning_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for reasoning/thinking token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.reasoning_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.reasoning_token","typeLabel":"number | null"},"prediction_accepted_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for accepted predicted-output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.prediction_accepted_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for accepted predicted-output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.prediction_accepted_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.prediction_accepted_token","typeLabel":"number | null"},"prediction_rejected_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for rejected predicted-output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.prediction_rejected_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for rejected predicted-output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.prediction_rejected_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.prediction_rejected_token","typeLabel":"number | null"},"request_image_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for image-modality input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_image_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for image-modality input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_image_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_image_token","typeLabel":"number | null"},"response_image_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for image-modality output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_image_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for image-modality output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_image_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_image_token","typeLabel":"number | null"},"request_text_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for text-modality input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_text_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for text-modality input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_text_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.request_text_token","typeLabel":"number | null"},"response_text_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for text-modality output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_text_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for text-modality output token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_text_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.response_text_token","typeLabel":"number | null"},"cache_read_image_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-read image-input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_image_input_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for cache-read image-input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_image_input_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_image_input_token","typeLabel":"number | null"},"cache_read_text_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-read text-input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_text_input_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for cache-read text-input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_text_input_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_read_text_input_token","typeLabel":"number | null"},"cache_write_text_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-write text-input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_text_input_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for cache-write text-input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_text_input_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_text_input_token","typeLabel":"number | null"},"cache_write_image_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-write image-input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_image_input_token.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier for cache-write image-input token cost.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_image_input_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.cache_write_image_input_token","typeLabel":"number | null"},"image":{"oneOf":[{"type":"object","additionalProperties":false,"description":"Image generation pricing multipliers.","properties":{"default":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier applied to image generation pricing across all qualities and sizes.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.image.oneOf.0.default.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Multiplier applied to image generation pricing across all qualities and sizes.","uniqueKey":"pricing_adjustments.oneOf.0.multiplier.image.oneOf.0.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.image.oneOf.0.default","typeLabel":"number | null"}},"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.image.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"description":"Image generation pricing multipliers.","properties":{"default":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier applied to image generation pricing across all qualities and sizes."},{"type":"null","minimum":0,"description":"Multiplier applied to image generation pricing across all qualities and sizes."}]}},"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.image.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.image","typeLabel":"object | null"},"additional_units":{"oneOf":[{"type":"object","description":"Multipliers for per-unit charges such as `web_search`, `file_search`, `input_image`,\n`input_video_standard`. Keys must match those returned by Portkey Models for the provider.\n","additionalProperties":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units.oneOf.0.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units.oneOf.0.additionalProperties","typeLabel":"number | null"},"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units.oneOf.0","typeLabel":"object"},{"type":"null","description":"Multipliers for per-unit charges such as `web_search`, `file_search`, `input_image`,\n`input_video_standard`. Keys must match those returned by Portkey Models for the provider.\n","additionalProperties":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units.oneOf.1.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units.oneOf.1.additionalProperties","typeLabel":"number | null"},"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments.oneOf.0.multiplier.additional_units","typeLabel":"object | null"}},"uniqueKey":"pricing_adjustments.oneOf.0.multiplier","typeLabel":"object"}},"example":{"multiplier":{"default":0.8,"cache_read_input_token":0.9,"cache_write_input_token":0.9}},"uniqueKey":"pricing_adjustments.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"description":"Per-Integration pricing adjustments applied on top of Portkey's base model pricing\nfor cost tracking, analytics, and budget limits. Use to reflect negotiated discounts,\ncommitted-use rates, or internal markups for cost showback.\n","properties":{"multiplier":{"type":"object","additionalProperties":false,"description":"Multipliers applied to the corresponding pricing keys from\n[Portkey Models](https://portkey.ai/models). A multiplier of `1` leaves pricing\nunchanged, `0.8` applies a 20% discount, `1.2` applies a 20% markup. Missing or\n`null` fields inherit from `default`; if `default` is also unset, no change is applied.\nAll values must be non-negative numbers.\n","properties":{"default":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier applied to every token type unless a more specific multiplier is set."},{"type":"null","minimum":0,"description":"Multiplier applied to every token type unless a more specific multiplier is set."}]},"request_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for input/request token cost."},{"type":"null","minimum":0,"description":"Multiplier for input/request token cost."}]},"response_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for output/response token cost."},{"type":"null","minimum":0,"description":"Multiplier for output/response token cost."}]},"cache_read_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-read input token cost."},{"type":"null","minimum":0,"description":"Multiplier for cache-read input token cost."}]},"cache_write_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-write input token cost."},{"type":"null","minimum":0,"description":"Multiplier for cache-write input token cost."}]},"cache_read_audio_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-read audio input token cost."},{"type":"null","minimum":0,"description":"Multiplier for cache-read audio input token cost."}]},"request_audio_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for audio input token cost."},{"type":"null","minimum":0,"description":"Multiplier for audio input token cost."}]},"response_audio_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for audio output token cost."},{"type":"null","minimum":0,"description":"Multiplier for audio output token cost."}]},"reasoning_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for reasoning/thinking token cost."},{"type":"null","minimum":0,"description":"Multiplier for reasoning/thinking token cost."}]},"prediction_accepted_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for accepted predicted-output token cost."},{"type":"null","minimum":0,"description":"Multiplier for accepted predicted-output token cost."}]},"prediction_rejected_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for rejected predicted-output token cost."},{"type":"null","minimum":0,"description":"Multiplier for rejected predicted-output token cost."}]},"request_image_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for image-modality input token cost."},{"type":"null","minimum":0,"description":"Multiplier for image-modality input token cost."}]},"response_image_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for image-modality output token cost."},{"type":"null","minimum":0,"description":"Multiplier for image-modality output token cost."}]},"request_text_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for text-modality input token cost."},{"type":"null","minimum":0,"description":"Multiplier for text-modality input token cost."}]},"response_text_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for text-modality output token cost."},{"type":"null","minimum":0,"description":"Multiplier for text-modality output token cost."}]},"cache_read_image_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-read image-input token cost."},{"type":"null","minimum":0,"description":"Multiplier for cache-read image-input token cost."}]},"cache_read_text_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-read text-input token cost."},{"type":"null","minimum":0,"description":"Multiplier for cache-read text-input token cost."}]},"cache_write_text_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-write text-input token cost."},{"type":"null","minimum":0,"description":"Multiplier for cache-write text-input token cost."}]},"cache_write_image_input_token":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier for cache-write image-input token cost."},{"type":"null","minimum":0,"description":"Multiplier for cache-write image-input token cost."}]},"image":{"oneOf":[{"type":"object","additionalProperties":false,"description":"Image generation pricing multipliers.","properties":{"default":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier applied to image generation pricing across all qualities and sizes."},{"type":"null","minimum":0,"description":"Multiplier applied to image generation pricing across all qualities and sizes."}]}}},{"type":"null","additionalProperties":false,"description":"Image generation pricing multipliers.","properties":{"default":{"oneOf":[{"type":"number","minimum":0,"description":"Multiplier applied to image generation pricing across all qualities and sizes."},{"type":"null","minimum":0,"description":"Multiplier applied to image generation pricing across all qualities and sizes."}]}}}]},"additional_units":{"oneOf":[{"type":"object","description":"Multipliers for per-unit charges such as `web_search`, `file_search`, `input_image`,\n`input_video_standard`. Keys must match those returned by Portkey Models for the provider.\n","additionalProperties":{"oneOf":[{"type":"number","minimum":0},{"type":"null","minimum":0}]}},{"type":"null","description":"Multipliers for per-unit charges such as `web_search`, `file_search`, `input_image`,\n`input_video_standard`. Keys must match those returned by Portkey Models for the provider.\n","additionalProperties":{"oneOf":[{"type":"number","minimum":0},{"type":"null","minimum":0}]}}]}}}},"example":{"multiplier":{"default":0.8,"cache_read_input_token":0.9,"cache_write_input_token":0.9}},"uniqueKey":"pricing_adjustments.oneOf.1","typeLabel":"null"}],"uniqueKey":"pricing_adjustments","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","organisation_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ai_provider_id":"\u003cstring>","name":"\u003cstring>","status":"active","created_at":"2023-11-07T05:31:56Z","last_updated_at":"2023-11-07T05:31:56Z","slug":"\u003cstring>","description":"\u003cstring>","tags":{},"object":"integration","masked_key":"\u003cstring>","configurations":{"provider_auth_type":"apiKey","openai_organization":"\u003cstring>","openai_project":"\u003cstring>","oauth_token_endpoint":"\u003cstring>","oauth_client_id":"\u003cstring>","oauth_client_secret":"\u003cstring>","oauth_scope":"\u003cstring>","wif_identity_source":"configuredIdp","oauth_audience":"\u003cstring>","openai_identity_provider_id":"\u003cstring>","openai_service_account_id":"\u003cstring>","is_key_required":true},"global_workspace_access_settings":{"enabled":true,"usage_limits":[{"credit_limit":10,"periodic_reset":"monthly","alert_threshold":8}],"rate_limits":[{"type":"requests","unit":"rpd","value":123}]},"allow_all_models":true,"workspace_count":123,"secret_mappings":[{"target_field":"key","secret_reference_id":"my-aws-secret","secret_key":"\u003cstring>","value_format":"json"}],"pricing_adjustments":{"multiplier":{"default":0.8,"cache_read_input_token":0.9,"cache_write_input_token":0.9}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8921f4af-dcc2-4019-92de-fba18beb8448":{"Portkey-Key":{"type":"apiKey","in":"header","name":"x-portkey-api-key","scopes":[],"schemeName":"Portkey-Key"}}},"servers":{"8764b1a7-5267-4a5b-8408-9784f63bb043":{"url":"https://api.portkey.ai/v1","description":"Portkey API Public Endpoint"},"c1e92644-752d-440e-a764-db569a62980a":{"url":"SELF_HOSTED_CONTROL_PLANE_URL","description":"Self-Hosted Control Plane URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-portkey-api-key","scopes":[],"schemeName":"Portkey-Key"},"schema":{"title":"x-portkey-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Portkey-Key","name":"x-portkey-api-key"}],"title":"Portkey-Key"}]},"originalFileLocation":"https://raw.githubusercontent.com/Portkey-AI/openapi/refs/heads/master/openapi.yaml"},"subdomain":"portkey-docs","siteName":"Portkey (Prisma AIRS AI Gateway) Docs","title":"Retrieve Integration - Portkey (Prisma AIRS AI Gateway) Docs","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"contextualStarterQuestions":[{"_id":"6aa971a20031bd0287c96098","deploymentId":"67086365a151447bf2fa5021","questionText":"How do I retrieve an integration?","status":"active","generatedBy":"contextual","path":"api-reference/admin-api/control-plane/integrations/retrieve-integration","createdAt":"2026-09-15T16:26:10.287Z","updatedAt":"2026-09-15T16:26:10.287Z","__v":0},{"_id":"6aa971a20031bd0287c9609a","deploymentId":"67086365a151447bf2fa5021","questionText":"How do I get integration details?","status":"active","generatedBy":"contextual","path":"api-reference/admin-api/control-plane/integrations/retrieve-integration","createdAt":"2026-09-15T16:26:10.287Z","updatedAt":"2026-09-15T16:26:10.287Z","__v":0},{"_id":"6aa971a20031bd0287c96099","deploymentId":"67086365a151447bf2fa5021","questionText":"What's the integration API endpoint?","status":"active","generatedBy":"contextual","path":"api-reference/admin-api/control-plane/integrations/retrieve-integration","createdAt":"2026-09-15T16:26:10.287Z","updatedAt":"2026-09-15T16:26:10.287Z","__v":0}],"navMaps":{"firstHrefInVersion":{"Latest":{"href":"/api-reference/admin-api/control-plane/integrations/retrieve-integration","matchLevel":0},"Prisma AIRS":{"href":"/aigw/integrations/overview","matchLevel":2},"Virtual Keys (Deprecated)":{"href":"/guides/integrations","matchLevel":2}},"firstHrefInLanguage":{},"searchTabScopes":[{"version":"Latest","tab":"Docs"},{"version":"Latest","tab":"Integrations"},{"version":"Latest","tab":"Gateway APIs"},{"version":"Latest","tab":"Admin APIs"},{"version":"Latest","tab":"Cookbooks"},{"version":"Latest","tab":"Changelog"},{"version":"Latest","tab":"Help Center"},{"version":"Prisma AIRS","tab":"Docs"},{"version":"Prisma AIRS","tab":"Integrations"},{"version":"Prisma AIRS","tab":"Self-Hosting"},{"version":"Prisma AIRS","tab":"Gateway APIs"},{"version":"Prisma AIRS","tab":"Admin APIs"},{"version":"Prisma AIRS","tab":"Changelog"},{"version":"Prisma AIRS","tab":"Help Center"},{"version":"Virtual Keys (Deprecated)","tab":"Documentation"},{"version":"Virtual Keys (Deprecated)","tab":"Integrations"},{"version":"Virtual Keys (Deprecated)","tab":"Inference API"},{"version":"Virtual Keys (Deprecated)","tab":"Admin API"},{"version":"Virtual Keys (Deprecated)","tab":"Cookbooks"},{"version":"Virtual Keys (Deprecated)","tab":"Changelog"},{"version":"Virtual Keys (Deprecated)","tab":"Help articles"}]},"lastModified":"2026-09-15T13:55:28.944Z","gitLastModified":"2026-08-06T05:55:04.000Z","originalFileLocation":"api-reference/admin-api/control-plane/integrations/retrieve-integration.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Portkey (Prisma AIRS AI Gateway) Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_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=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve Integration - Portkey (Prisma AIRS AI Gateway) Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Portkey AI Gateway Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://portkey-docs.mintlify.site/docs/_mintlify/api/og/v2?division=Integrations\u0026amp;title=Retrieve+Integration\u0026amp;theme=2e705b99838d8114148ccc56\u0026amp;signature=e1d3990ae5a541e12dbfee84c0213cb0ea82be15069d72e7614b0e17bf20d5b1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve Integration - Portkey (Prisma AIRS AI Gateway) Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://portkey-docs.mintlify.site/docs/_mintlify/api/og/v2?division=Integrations\u0026amp;title=Retrieve+Integration\u0026amp;theme=2e705b99838d8114148ccc56\u0026amp;signature=e1d3990ae5a541e12dbfee84c0213cb0ea82be15069d72e7614b0e17bf20d5b1\">\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=\"/docs/mintlify-assets/_mintlify/favicons/portkey-docs/9Whrk-8bCE6hyGSn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Portkey (Prisma AIRS AI Gateway) Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0891B2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.portkey.ai/#organization\",\"name\":\"Portkey (Prisma AIRS AI Gateway) Docs\",\"url\":\"https://docs.portkey.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/portkey-docs/tHk-hgNjLbEj4dhh/images/portkey-PANW-company-logo-positive.png?fit=max\u0026auto=format\u0026n=tHk-hgNjLbEj4dhh\u0026q=85\u0026s=c5fb09014ff79616583b1d3bffe27450\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.portkey.ai/docs#website\",\"name\":\"Portkey (Prisma AIRS AI Gateway) Docs\",\"url\":\"https://docs.portkey.ai/docs\",\"publisher\":{\"@id\":\"https://docs.portkey.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration#webpage\",\"url\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration\",\"name\":\"Retrieve Integration\",\"dateModified\":\"2026-08-06T05:55:04.000Z\",\"isPartOf\":{\"@id\":\"https://docs.portkey.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Integrations\",\"item\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/create-integration\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve Integration\",\"item\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration#apireference\",\"headline\":\"Retrieve Integration\",\"name\":\"Retrieve Integration\",\"url\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration\",\"mainEntityOfPage\":{\"@id\":\"https://docs.portkey.ai/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration#webpage\"},\"dateModified\":\"2026-08-06T05:55:04.000Z\",\"publisher\":{\"@id\":\"https://docs.portkey.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.portkey.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Portkey (Prisma AIRS AI Gateway) Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Portkey (Prisma AIRS AI Gateway) Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/admin-api/control-plane/integrations/retrieve-integration.md","siteName":"Portkey (Prisma AIRS AI Gateway) Docs","nav":{"global":null,"versions":[{"version":"Latest","tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/introduction/what-is-portkey"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/ecosystem"}]},{"tab":"Gateway APIs","pages":[{"title":"Gateway APIs","href":"/api-reference/inference-api/introduction"}]},{"tab":"Admin APIs","groups":[{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/admin-api/introduction"},{"title":"Errors","href":"/api-reference/admin-api/error"}]},{"group":"Configs","pages":[{"title":"Create Config","openapi":"post /configs","href":"/api-reference/admin-api/control-plane/configs/create-config"},{"title":"List Configs","openapi":"get /configs","href":"/api-reference/admin-api/control-plane/configs/list-configs"},{"title":"Retrieve Config","openapi":"get /configs/{slug}","href":"/api-reference/admin-api/control-plane/configs/retrieve-config"},{"title":"List Config Versions","openapi":"get /configs/{slug}/versions","href":"/api-reference/admin-api/control-plane/configs/list-config-versions"},{"title":"Update Config","openapi":"put /configs/{slug}","href":"/api-reference/admin-api/control-plane/configs/update-config"},{"title":"Delete Config","openapi":"delete /configs/{slug}","href":"/api-reference/admin-api/control-plane/configs/delete-config"}]},{"group":"Integrations","pages":[{"title":"Create Integration","openapi":"post /integrations","href":"/api-reference/admin-api/control-plane/integrations/create-integration"},{"title":"List Integrations","openapi":"get /integrations","description":"","href":"/api-reference/admin-api/control-plane/integrations/list-integrations"},{"title":"Retrieve Integration","openapi":"get /integrations/{slug}","href":"/api-reference/admin-api/control-plane/integrations/retrieve-integration"},{"title":"Update Integration","openapi":"put /integrations/{slug}","description":"","href":"/api-reference/admin-api/control-plane/integrations/update-integration"},{"title":"Delete Integration","openapi":"delete /integrations/{slug}","href":"/api-reference/admin-api/control-plane/integrations/delete-integration"},{"group":"Model Access","pages":[{"title":"List Model Access","openapi":"get /integrations/{slug}/models","href":"/api-reference/admin-api/control-plane/integrations/models/list-model-access"},{"title":"Update Model Access","openapi":"put /integrations/{slug}/models","href":"/api-reference/admin-api/control-plane/integrations/models/update-model-access"},{"title":"Delete Custom Model","openapi":"delete /integrations/{slug}/models","href":"/api-reference/admin-api/control-plane/integrations/models/delete-custom-model"}]},{"group":"Workspace Access","pages":[{"title":"List Workspace Access","openapi":"get /integrations/{slug}/workspaces","href":"/api-reference/admin-api/control-plane/integrations/workspaces/list-workspace-access"},{"title":"Update Workspace Access","openapi":"put /integrations/{slug}/workspaces","href":"/api-reference/admin-api/control-plane/integrations/workspaces/update-workspace-access"}]}]},{"group":"MCP Integrations","pages":[{"title":"Create MCP Integration","openapi":"post /mcp-integrations","href":"/api-reference/admin-api/control-plane/mcp-integrations/create-mcp-integration"},{"title":"List MCP Integrations","openapi":"get /mcp-integrations","href":"/api-reference/admin-api/control-plane/mcp-integrations/list-mcp-integrations"},{"title":"Retrieve MCP Integration","openapi":"get /mcp-integrations/{mcpIntegrationId}","href":"/api-reference/admin-api/control-plane/mcp-integrations/retrieve-mcp-integration"},{"title":"Update MCP Integration","openapi":"put /mcp-integrations/{mcpIntegrationId}","href":"/api-reference/admin-api/control-plane/mcp-integrations/update-mcp-integration"},{"title":"Delete MCP Integration","openapi":"delete /mcp-integrations/{mcpIntegrationId}","href":"/api-reference/admin-api/control-plane/mcp-integrations/delete-mcp-integration"},{"group":"Workspaces","pages":[{"title":"List MCP Integration Workspaces","openapi":"get /mcp-integrations/{mcpIntegrationId}/workspaces","href":"/api-reference/admin-api/control-plane/mcp-integrations/workspaces/list-mcp-integration-workspaces"},{"title":"Update MCP Integration Workspaces","openapi":"put /mcp-integrations/{mcpIntegrationId}/workspaces","href":"/api-reference/admin-api/control-plane/mcp-integrations/workspaces/update-mcp-integration-workspaces"}]},{"group":"Capabilities","pages":[{"title":"List MCP Integration Capabilities","openapi":"get /mcp-integrations/{mcpIntegrationId}/capabilities","href":"/api-reference/admin-api/control-plane/mcp-integrations/capabilities/list-mcp-integration-capabilities"},{"title":"Update MCP Integration Capabilities","openapi":"put /mcp-integrations/{mcpIntegrationId}/capabilities","href":"/api-reference/admin-api/control-plane/mcp-integrations/capabilities/update-mcp-integration-capabilities"}]},{"title":"Retrieve MCP Integration Metadata","openapi":"get /mcp-integrations/{mcpIntegrationId}/metadata","href":"/api-reference/admin-api/control-plane/mcp-integrations/retrieve-mcp-integration-metadata"}]},{"group":"MCP Servers","pages":[{"title":"Create MCP Server","openapi":"post /mcp-servers","href":"/api-reference/admin-api/control-plane/mcp-servers/create-mcp-server"},{"title":"List MCP Servers","openapi":"get /mcp-servers","href":"/api-reference/admin-api/control-plane/mcp-servers/list-mcp-servers"},{"title":"Retrieve MCP Server","openapi":"get /mcp-servers/{mcpServerId}","href":"/api-reference/admin-api/control-plane/mcp-servers/retrieve-mcp-server"},{"title":"Update MCP Server","openapi":"put /mcp-servers/{mcpServerId}","href":"/api-reference/admin-api/control-plane/mcp-servers/update-mcp-server"},{"title":"Delete MCP Server","openapi":"delete /mcp-servers/{mcpServerId}","href":"/api-reference/admin-api/control-plane/mcp-servers/delete-mcp-server"},{"title":"Test MCP Server connection","openapi":"post /mcp-servers/{mcpServerId}/test","href":"/api-reference/admin-api/control-plane/mcp-servers/test-mcp-server"},{"group":"Capabilities","pages":[{"title":"List MCP Server capabilities","openapi":"get /mcp-servers/{mcpServerId}/capabilities","href":"/api-reference/admin-api/control-plane/mcp-servers/capabilities/list-mcp-server-capabilities"},{"title":"Bulk update MCP Server capability overrides","openapi":"put /mcp-servers/{mcpServerId}/capabilities","href":"/api-reference/admin-api/control-plane/mcp-servers/capabilities/bulk-update-mcp-server-capabilities"}]},{"group":"User Access","pages":[{"title":"List MCP Server user access","openapi":"get /mcp-servers/{mcpServerId}/user-access","href":"/api-reference/admin-api/control-plane/mcp-servers/user-access/list-mcp-server-user-access"},{"title":"Bulk update MCP Server user access","openapi":"put /mcp-servers/{mcpServerId}/user-access","href":"/api-reference/admin-api/control-plane/mcp-servers/user-access/bulk-update-mcp-server-user-access"}]},{"group":"Connections","pages":[{"title":"List MCP Server Connections","openapi":"get /mcp-servers/{mcpServerId}/connections","href":"/api-reference/admin-api/control-plane/mcp-servers/connections/list-mcp-server-connections"},{"title":"Delete MCP Server Connection","openapi":"delete /mcp-servers/{mcpServerId}/connections","href":"/api-reference/admin-api/control-plane/mcp-servers/connections/delete-mcp-server-connection"}]}]},{"group":"Providers","pages":[{"title":"Create Provider","openapi":"post /providers","href":"/api-reference/admin-api/control-plane/providers/create-provider"},{"title":"List Providers","openapi":"get /providers","href":"/api-reference/admin-api/control-plane/providers/list-providers"},{"title":"Retrieve Provider","openapi":"get /providers/{slug}","href":"/api-reference/admin-api/control-plane/providers/retrieve-provider"},{"title":"Update Provider","openapi":"put /providers/{slug}","href":"/api-reference/admin-api/control-plane/providers/update-provider"},{"title":"Delete Provider","openapi":"delete /providers/{slug}","href":"/api-reference/admin-api/control-plane/providers/delete-provider"}]},{"group":"Virtual Keys","pages":[{"title":"Create Virtual Key","openapi":"post /virtual-keys","href":"/api-reference/admin-api/control-plane/virtual-keys/create-virtual-key"},{"title":"List Virtual Key","openapi":"get /virtual-keys","href":"/api-reference/admin-api/control-plane/virtual-keys/list-virtual-keys"},{"title":"Retrieve Virtual Key","openapi":"get /virtual-keys/{slug}","href":"/api-reference/admin-api/control-plane/virtual-keys/retrieve-virtual-key"},{"title":"Update Virtual Key","openapi":"put /virtual-keys/{slug}","href":"/api-reference/admin-api/control-plane/virtual-keys/update-virtual-key"},{"title":"Delete Virtual Key","openapi":"delete /virtual-keys/{slug}","href":"/api-reference/admin-api/control-plane/virtual-keys/delete-virtual-key"}]},{"group":"Prompts","pages":[{"title":"Create Prompt","openapi":"post /prompts","href":"/api-reference/admin-api/control-plane/prompts/create-prompt"},{"title":"List Prompts","openapi":"get /prompts","href":"/api-reference/admin-api/control-plane/prompts/list-prompts"},{"title":"Retrieve Prompt","openapi":"get /prompts/{promptId}","href":"/api-reference/admin-api/control-plane/prompts/retrieve-prompt"},{"title":"Update Prompt","openapi":"put /prompts/{promptId}","href":"/api-reference/admin-api/control-plane/prompts/update-prompt"},{"title":"Delete Prompt","openapi":"delete /prompts/{promptId}","href":"/api-reference/admin-api/control-plane/prompts/delete-prompt"},{"title":"Publish Prompt","openapi":"put /prompts/{promptId}/makeDefault","href":"/api-reference/admin-api/control-plane/prompts/publish-prompt"},{"title":"List Prompt Versions","openapi":"get /prompts/{promptId}/versions","href":"/api-reference/admin-api/control-plane/prompts/list-prompt-versions"},{"title":"Retrieve Prompt Version","openapi":"get /prompts/{promptId}/versions/{versionId}","href":"/api-reference/admin-api/control-plane/prompts/retrieve-prompt-version"},{"title":"Update Prompt Version","openapi":"put /prompts/{promptId}/versions/{versionId}","href":"/api-reference/admin-api/control-plane/prompts/update-prompt-version"},{"group":"Prompt Partials","pages":[{"title":"Create Partial","openapi":"post /prompts/partials","href":"/api-reference/admin-api/control-plane/prompts/partials/create-partial"},{"title":"List Partials","openapi":"get /prompts/partials","href":"/api-reference/admin-api/control-plane/prompts/partials/list-partials"},{"title":"Retrieve Partial","openapi":"get /prompts/partials/{promptPartialId}","href":"/api-reference/admin-api/control-plane/prompts/partials/retrieve-partial"},{"title":"Update Partial","openapi":"put /prompts/partials/{promptPartialId}","href":"/api-reference/admin-api/control-plane/prompts/partials/update-partial"},{"title":"Delete Partial","openapi":"delete /prompts/partials/{promptPartialId}","href":"/api-reference/admin-api/control-plane/prompts/partials/delete-partial"},{"title":"List Partial Versions","openapi":"get /prompts/partials/{promptPartialId}/versions","href":"/api-reference/admin-api/control-plane/prompts/partials/list-partial-versions"},{"title":"Publish Partial","openapi":"put /prompts/partials/{promptPartialId}/makeDefault","href":"/api-reference/admin-api/control-plane/prompts/partials/publish-partial"}]},{"group":"Prompt Labels","pages":[{"title":"Create Label","openapi":"post /labels","href":"/api-reference/admin-api/control-plane/prompts/labels/create-label"},{"title":"List Labels","openapi":"get /labels","href":"/api-reference/admin-api/control-plane/prompts/labels/list-labels"},{"title":"Retrieve Label","openapi":"get /labels/{labelId}","href":"/api-reference/admin-api/control-plane/prompts/labels/retrieve-label"},{"title":"Update Label","openapi":"put /labels/{labelId}","href":"/api-reference/admin-api/control-plane/prompts/labels/update-label"},{"title":"Delete Label","openapi":"delete /labels/{labelId}","href":"/api-reference/admin-api/control-plane/prompts/labels/delete-label"}]},{"group":"Prompt Collections","pages":[{"title":"Create Prompt Collection","openapi":"post /collections","href":"/api-reference/admin-api/control-plane/prompts/collections/create-collection"},{"title":"List Prompt Collections","openapi":"get /collections","href":"/api-reference/admin-api/control-plane/prompts/collections/list-collections"},{"title":"Retrieve Prompt Collection","openapi":"get /collections/{collectionId}","href":"/api-reference/admin-api/control-plane/prompts/collections/retrieve-collection"},{"title":"Update Prompt Collection","openapi":"put /collections/{collectionId}","href":"/api-reference/admin-api/control-plane/prompts/collections/update-collection"},{"title":"Delete Prompt Collection","openapi":"delete /collections/{collectionId}","href":"/api-reference/admin-api/control-plane/prompts/collections/delete-collection"}]}]},{"group":"API Keys","pages":[{"title":"Create API Key","openapi":"post /api-keys/{type}/{sub-type}","href":"/api-reference/admin-api/control-plane/api-keys/create-api-key"},{"title":"Update API Key","openapi":"put /api-keys/{id}","href":"/api-reference/admin-api/control-plane/api-keys/update-api-key"},{"title":"Rotate API Key","openapi":"post /api-keys/{id}/rotate","href":"/api-reference/admin-api/control-plane/api-keys/rotate-api-key"},{"title":"Delete an API Key","openapi":"delete /api-keys/{id}","href":"/api-reference/admin-api/control-plane/api-keys/delete-an-api-key"},{"title":"Retrieve an API Key","openapi":"get /api-keys/{id}","href":"/api-reference/admin-api/control-plane/api-keys/retrieve-an-api-key"},{"title":"List API Key","openapi":"get /api-keys","href":"/api-reference/admin-api/control-plane/api-keys/list-api-keys"}]},{"group":"Analytics [BETA]","pages":[{"group":"Summary","pages":[{"title":"Get User Grouped Data","openapi":"get /analytics/groups/users","href":"/api-reference/admin-api/control-plane/analytics/summary/get-all-cache-data"}]},{"group":"Groups Paginated Data","pages":[{"title":"Get Metadata Grouped Data","openapi":"get /analytics/groups/metadata/{metadataKey}","href":"/api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-metadata-grouped-data"},{"title":"Get Model Grouped Data","openapi":"get /analytics/groups/ai-models","href":"/api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-model-grouped-data"},{"title":"Get Provider Grouped Data","openapi":"get /analytics/groups/provider","href":"/api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-provider-grouped-data"},{"title":"Get User Grouped Data","openapi":"get /analytics/groups/users","href":"/api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-user-grouped-data"}]},{"group":"Graphs - Time Series Data","pages":[{"title":"Get cache hit latency data","openapi":"get /analytics/graphs/cache/latency","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cache-hit-latency-data"},{"title":"Get cache hit rate data","openapi":"get /analytics/graphs/cache/hit-rate","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cache-hit-rate-data"},{"title":"Get cost data","openapi":"get /analytics/graphs/cost","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cost-data"},{"title":"Get error rate data","openapi":"get /analytics/graphs/errors/rate","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-error-rate-data"},{"title":"Get errors data","openapi":"get /analytics/graphs/errors","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-errors-data"},{"title":"Get feedback data","openapi":"get /analytics/graphs/feedbacks","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-data"},{"title":"Get feedback per ai models data","openapi":"get /analytics/graphs/feedbacks/ai-models","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-per-ai-models-data"},{"title":"Get feedback score distribution data","openapi":"get /analytics/graphs/feedbacks/scores","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-score-distribution-data"},{"title":"Get latency data","openapi":"get /analytics/graphs/latency","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-latency-data"},{"title":"Get requests data","openapi":"get /analytics/graphs/requests","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-requests-data"},{"title":"Get requests per user data","openapi":"get /analytics/graphs/users/requests","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-requests-per-user-data"},{"title":"Get rescued requests data","openapi":"get /analytics/graphs/requests/rescued","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-rescued-requests-data"},{"title":"Get status code data","openapi":"get /analytics/graphs/errors/stacks","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-status-code-data"},{"title":"Get tokens data","openapi":"get /analytics/graphs/tokens","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-tokens-data"},{"title":"Get unique status code data","openapi":"get /analytics/graphs/errors/status-codes","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-unique-status-code-data"},{"title":"Get users data","openapi":"get /analytics/graphs/users","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-users-data"},{"title":"Get weighted feedback data","openapi":"get /analytics/graphs/feedbacks/weighted","href":"/api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-weighted-feedback-data"}]}]},{"group":"Users","pages":[{"title":"Retrieve a user","openapi":"get /admin/users/{userId}","href":"/api-reference/admin-api/control-plane/users/retrieve-a-user"},{"title":"Retrieve all users","openapi":"get /admin/users","href":"/api-reference/admin-api/control-plane/users/retrieve-all-users"},{"title":"Update a user","openapi":"put /admin/users/{userId}","href":"/api-reference/admin-api/control-plane/users/update-a-user"},{"title":"Remove a user","openapi":"delete /admin/users/{userId}","href":"/api-reference/admin-api/control-plane/users/remove-a-user"}]},{"group":"User Invites","pages":[{"title":"Invite a User","openapi":"post /admin/users/invites","href":"/api-reference/admin-api/control-plane/user-invites/invite-a-user"},{"title":"Retrieve an user invite","openapi":"get /admin/users/invites/{inviteId}","href":"/api-reference/admin-api/control-plane/user-invites/retrieve-an-invite"},{"title":"Retrieve all user invite","openapi":"get /admin/users/invites","href":"/api-reference/admin-api/control-plane/user-invites/retrieve-all-user-invites"},{"title":"Delete a user invite","openapi":"delete /admin/users/invites/{inviteId}","href":"/api-reference/admin-api/control-plane/user-invites/delete-a-user-invite"},{"title":"Resend a user invite","openapi":"post /admin/users/invites/{inviteId}/resend","href":"/api-reference/admin-api/control-plane/user-invites/resend-a-user-invite"}]},{"group":"Workspaces","pages":[{"title":"Create Workspace","openapi":"post /admin/workspaces","href":"/api-reference/admin-api/control-plane/workspaces/create-workspace"},{"title":"Retrieve all Workspaces","openapi":"get /admin/workspaces","href":"/api-reference/admin-api/control-plane/workspaces/retrieve-all-workspaces"},{"title":"Retrieve a Workspace","openapi":"get /admin/workspaces/{workspaceId}","href":"/api-reference/admin-api/control-plane/workspaces/retrieve-a-workspace"},{"title":"Update Workspace","openapi":"put /admin/workspaces/{workspaceId}","href":"/api-reference/admin-api/control-plane/workspaces/update-workspace"},{"title":"Delete a Workspace","openapi":"delete /admin/workspaces/{workspaceId}","href":"/api-reference/admin-api/control-plane/workspaces/delete-a-workspace"}]},{"group":"Workspace Members","pages":[{"title":"Add a Workspace Member","openapi":"post /admin/workspaces/{workspaceId}/users","href":"/api-reference/admin-api/control-plane/workspace-members/add-a-workspace-member"},{"title":"Retrieve all Workspace Member","openapi":"get /admin/workspaces/{workspaceId}/users","href":"/api-reference/admin-api/control-plane/workspace-members/retrieve-all-workspace-members"},{"title":"Retrieve a Workspace Member","openapi":"get /admin/workspaces/{workspaceId}/users/{userId}","href":"/api-reference/admin-api/control-plane/workspace-members/retrieve-a-workspace-member"},{"title":"Update Workspace Member","openapi":"put /admin/workspaces/{workspaceId}/users/{userId}","href":"/api-reference/admin-api/control-plane/workspace-members/update-workspace-member"},{"title":"Remove Workspace Member","openapi":"delete /admin/workspaces/{workspaceId}/users/{userId}","href":"/api-reference/admin-api/control-plane/workspace-members/remove-workspace-member"}]},{"group":"SCIM Workspace Mappings","pages":[{"title":"List SCIM Workspace Mappings","openapi":"get /scim/workspaces","href":"/api-reference/admin-api/control-plane/scim-workspace-mappings/list-scim-workspace-mappings"},{"title":"Create SCIM Workspace Mapping","openapi":"post /scim/workspaces","href":"/api-reference/admin-api/control-plane/scim-workspace-mappings/create-scim-workspace-mapping"},{"title":"Delete SCIM Workspace Mapping","openapi":"delete /scim/workspaces/{scimWorkspaceGroupId}","href":"/api-reference/admin-api/control-plane/scim-workspace-mappings/delete-scim-workspace-mapping"}]},{"group":"Audit Logs","pages":[{"title":"List Audit Logs","openapi":"get /audit-logs","href":"/api-reference/admin-api/control-plane/audit-logs/list-audit-logs"}]},{"group":"Guardrails","pages":[{"title":"Create Guardrail","openapi":"post /guardrails","href":"/api-reference/admin-api/control-plane/guardrails/create-guardrail"},{"title":"List Guardrails","openapi":"get /guardrails","href":"/api-reference/admin-api/control-plane/guardrails/list-guardrails"},{"title":"Retrieve Guardrail","openapi":"get /guardrails/{guardrailId}","href":"/api-reference/admin-api/control-plane/guardrails/retrieve-guardrail"},{"title":"Update Guardrail","openapi":"put /guardrails/{guardrailId}","href":"/api-reference/admin-api/control-plane/guardrails/update-guardrail"},{"title":"Delete Guardrail","openapi":"delete /guardrails/{guardrailId}","href":"/api-reference/admin-api/control-plane/guardrails/delete-guardrail"}]},{"group":"Secret References","pages":[{"title":"Create Secret Reference","openapi":"post /secret-references","href":"/api-reference/admin-api/control-plane/secret-references/create-secret-reference"},{"title":"List Secret References","openapi":"get /secret-references","href":"/api-reference/admin-api/control-plane/secret-references/list-secret-references"},{"title":"Retrieve Secret Reference","openapi":"get /secret-references/{secretReferenceId}","href":"/api-reference/admin-api/control-plane/secret-references/retrieve-secret-reference"},{"title":"Update Secret Reference","openapi":"put /secret-references/{secretReferenceId}","href":"/api-reference/admin-api/control-plane/secret-references/update-secret-reference"},{"title":"Delete Secret Reference","openapi":"delete /secret-references/{secretReferenceId}","href":"/api-reference/admin-api/control-plane/secret-references/delete-secret-reference"}]},{"group":"Policies","pages":[{"group":"Usage Limits","pages":[{"title":"Create Usage Limits Policy","openapi":"post /policies/usage-limits","href":"/api-reference/admin-api/control-plane/policies/usage-limits/create-usage-limits-policy"},{"title":"List Usage Limits Policy","openapi":"get /policies/usage-limits","href":"/api-reference/admin-api/control-plane/policies/usage-limits/list-usage-limits-policy"},{"title":"Retrieve Usage Limits Policy","openapi":"get /policies/usage-limits/{policyUsageLimitsId}","href":"/api-reference/admin-api/control-plane/policies/usage-limits/retrieve-usage-limits-policy"},{"title":"Update Usage Limits Policy","openapi":"put /policies/usage-limits/{policyUsageLimitsId}","href":"/api-reference/admin-api/control-plane/policies/usage-limits/update-usage-limits-policy"},{"title":"Delete Usage Limits Policy","openapi":"delete /policies/usage-limits/{policyUsageLimitsId}","href":"/api-reference/admin-api/control-plane/policies/usage-limits/delete-usage-limits-policy"},{"title":"List Usage Limits Policy Entities","openapi":"get /policies/usage-limits/{policyUsageLimitsId}/entities","href":"/api-reference/admin-api/control-plane/policies/usage-limits/list-usage-limits-policy-entities"},{"title":"Reset Usage Limits Policy Entity","openapi":"put /policies/usage-limits/{policyUsageLimitsId}/entities/{entityId}/reset","href":"/api-reference/admin-api/control-plane/policies/usage-limits/reset-usage-limits-policy-entity"}]},{"group":"Rate Limits","pages":[{"title":"Create Rate Limits Policy","openapi":"post /policies/rate-limits","href":"/api-reference/admin-api/control-plane/policies/rate-limits/create-rate-limits-policy"},{"title":"List Rate Limits Policy","openapi":"get /policies/rate-limits","href":"/api-reference/admin-api/control-plane/policies/rate-limits/list-rate-limits-policy"},{"title":"Retrieve Rate Limits Policy","openapi":"get /policies/rate-limits/{rateLimitsPolicyId}","href":"/api-reference/admin-api/control-plane/policies/rate-limits/retrieve-rate-limits-policy"},{"title":"Update Rate Limits Policy","openapi":"put /policies/rate-limits/{rateLimitsPolicyId}","href":"/api-reference/admin-api/control-plane/policies/rate-limits/update-rate-limits-policy"},{"title":"Delete Rate Limits Policy","openapi":"delete /policies/rate-limits/{rateLimitsPolicyId}","href":"/api-reference/admin-api/control-plane/policies/rate-limits/delete-rate-limits-policy"}]}]},{"group":"OpenAPI","pages":[{"title":"OpenAPI Specification","url":"https://github.com/Portkey-AI/openapi","href":"/api-reference/admin-api/open-api-specification"}]}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/guides/use-cases/run-batch-evals"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026/september"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help-center/you-do-not-have-enough-permissions"}]}]},{"version":"Prisma AIRS","pages":[{"title":"Prisma AIRS","href":"/aigw/integrations/overview"}]},{"version":"Virtual Keys (Deprecated)","pages":[{"title":"Virtual Keys (Deprecated)","href":"/guides/integrations"}]}]},"basePath":"","title":"Retrieve Integration - Portkey (Prisma AIRS AI Gateway) Docs","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}