Providers and configuration API
A shared provider is a reusable tenant-owned connection. Apps hold references to its label, so credential/model changes can affect every linked app after synchronization. Provider label and type are immutable.
Shared providers and model tests
Provider inputs
Creation requires label, provider_name and credentials for the selected provider type in provider_settings. Optional selected_models, model_costs and enabled configure availability. Optional tags, upstream_limits and per-model model_metadata describe the provider (region, service tier, context window, capabilities, known upstream limits and shared quota pools); they are descriptive and do not change routing or limit enforcement. Use the provider-settings field reference below and the credential requirements for your provider family. Managed QuilrAI providers do not require customer credentials.
SDK and Copilot Studio are app modes, not shared-provider types. Provider/protocol support remains deployment-dependent. See provider support.
Models and rates
selected_models is a full replacement list, with at most 1,000 names of up to 512 characters each. An empty list follows the existing unrestricted-provider convention where supported; it does not necessarily mean zero models are allowed. Use explicit model lists for finite allowlists.
model_costs is keyed by a selected model. Each item needs input_per_1m and output_per_1m (USD per million tokens) and can add cache, reasoning, tiered and per-unit rates; expand the ModelCost schema in the endpoint reference for every field. A supplied item replaces that model's stored item, a null item removes it, and other models keep theirs. These prices are used for request cost and spend budgets, after any tenant-wide budget rate for the same model.
Rotation and disabling
Omitted credentials remain unchanged on PATCH. Submit a new secret to rotate it. Do not send redacted placeholder values back. Changing authentication mode must supply required new-mode fields and removes incompatible old-mode credentials.
PATCH enabled:false to disable a shared provider. Its record and app attachments remain; re-enabling restores normal availability.
Delete a provider with its current version in If-Match. Deletion is refused with 409 provider_in_use, listing the apps, while any app attaches it: detach it from each app first (an app cannot drop its last provider, so attach a replacement first). A deleted provider leaves every quota pool it belonged to. GET /providers?include_deleted=true still lists deleted providers.
Tests and model discovery
Saving configuration never contacts the upstream provider. Run a test or a discovery when you want to check credentials or find model IDs. Every probe needs providers:write, can incur upstream usage, always answers 200 with the result in the body, and saves nothing: no provider change, no new version.
- Tests and discovery are bounded in both the number of models they probe and the time they take. When more models are selected than a connection test probes,
models_truncatedis true. A probe that runs out of time reportstimeout. - Tests use stored or supplied settings only. They take no arbitrary URL or request payload. Testing a disabled provider does not enable it.
- Secrets in upstream messages are replaced with
[redacted], and discovered models are reduced to non-secret fields such asid,owned_byand modalities. - Endpoints the management service cannot reach, such as a provider on a private network, are not probed: the saved-provider test reports
code: private_endpoint_unreachable, and the other probes reportskippedorunsupported. For such providers, use the console to test or discover models, or enter model IDs manually. GET /capabilitieslists the provider types each probe supports:model_test_provider_types,connection_test_provider_typesandmodel_discovery_provider_types.
List filters
GET /providers supports limit and cursor, plus these filters (all combined with AND):
Any other query parameter (for example q or label) is 400 invalid_request naming it in fields, instead of being ignored and returning every provider.
Saves and reads return { "provider": { ... }, "request_id": "..." }; ordinary responses omit upstream secrets. A PATCH that sends the same secret already stored returns the warning credentials_unchanged, and credentials_updated_at does not move (it records when the secret last changed). A provider test returns the warning model_deprecated when the provider says a tested model is deprecated or retired.
Provider endpoints
/providersList shared providers
Shared providers of the tenant with secret settings omitted. Filter by provider type, enabled state, tags (repeatable, ANDed) and selected models (repeatable, ANDed); deleted providers are included only with include_deleted=true.
readPath, query & header parameters 7
limit (query)integeroptionalPage size.
cursor (query)stringoptionalOpaque cursor from the previous page's next_cursor.
provider_name (query)stringoptionalExact provider type.
enabled (query)booleanoptionaltag (query)array<string>optionalRepeatable (ANDed). `key` matches a present, non-empty tag value; `key:value` (split at the first colon) matches a string exactly, a list member, or a boolean/number as JSON (true, 42). Each condition matches the provider's public tags (with presets) or any selected model's public model_metadata tags (including the derived canonical_model).
Array item specification
stringmodel (query)array<string>optionalRepeatable (ANDed). Exact ID in selected_models.
Array item specification
stringinclude_deleted (query)booleanoptionalNo request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers?limit=50' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/providersCreate a shared provider
Creates a tenant-wide provider that apps can attach. `label` and `provider_name` are immutable. Credentials go in `provider_settings` and are never returned. Saving never calls the upstream; use the test and available-models operations to check settings.
providers:writePath, query & header parameters 1
Idempotency-Key (header)stringrequiredUnique per logical write. A retry with the same key and body replays the original result for 24 hours; the same key with a different body is a 409.
Full request body specification application/json
Shared-provider configuration. Saves never call the upstream; use the test and available-models operations to check settings.
enabledbooleanoptionallabelstringrequiredTenant-unique display name; immutable.
model_costsmap<string, one of 2 variants>optionalMap value specification
ModelCost object
audio_input_per_1mnumber | nulloptionalaudio_input_per_secondnumber | nulloptionalaudio_input_per_second_byobject | nulloptionalMap value specification
numberaudio_output_per_1mnumber | nulloptionalaudio_output_per_secondnumber | nulloptionalaudio_output_per_second_byobject | nulloptionalMap value specification
numberbatch_multipliernumber | nulloptionalcache_per_1mnumber | nulloptionalDeprecated alias of cache_read_per_1m. Requests may send it (must equal cache_read_per_1m when both are sent); responses echo it equal to cache_read_per_1m whenever that is set, and it is never stored.
cache_read_per_1mnumber | nulloptionalcache_write_1h_per_1mnumber | nulloptionalcache_write_5m_per_1mnumber | nulloptionalcache_write_default_ttlstring | nulloptional"5m""1h""unpriced"nullcache_write_per_1mnumber | nulloptionalcode_execution_per_hournumber | nulloptionalcontainer_per_sessionnumber | nulloptionaldocument_image_input_per_imagenumber | nulloptionaldocument_image_input_per_image_byobject | nulloptionalMap value specification
numberfile_search_per_1knumber | nulloptionalgrounding_per_1knumber | nulloptionalimage_input_per_1mnumber | nulloptionalimage_input_per_imagenumber | nulloptionalimage_input_per_image_byobject | nulloptionalMap value specification
numberimage_output_per_1mnumber | nulloptionalimage_output_per_imagenumber | nulloptionalimage_output_per_image_byobject | nulloptionalMap value specification
numberinput_per_1mnumber | nullrequiredinput_per_1m_charactersnumber | nulloptionalinput_per_1m_characters_byobject | nulloptionalMap value specification
numberoutput_per_1mnumber | nullrequiredpages_per_1knumber | nulloptionalpages_per_1k_byobject | nulloptionalMap value specification
numberreasoning_per_1mnumber | nulloptionalregional_multipliersobject | nulloptionalObject fields
data_residencynumber | nulloptionalgeonumber | nulloptionalregionalnumber | nulloptionalus_onlynumber | nulloptionalUnknown fields are rejected in this object.
requests_per_1knumber | nulloptionalrequests_per_1k_byobject | nulloptionalMap value specification
numbersearch_units_per_1knumber | nulloptionalsearch_units_per_1k_byobject | nulloptionalMap value specification
numberservice_tier_multipliersobject | nulloptionalObject fields
fastnumber | nulloptionalflexnumber | nulloptionalprioritynumber | nulloptionalUnknown fields are rejected in this object.
text_input_per_requestnumber | nulloptionaltext_input_per_request_byobject | nulloptionalMap value specification
numbertiersarray | nulloptionalvideo_input_per_secondnumber | nulloptionalvideo_input_per_second_byobject | nulloptionalMap value specification
numbervideo_output_per_secondnumber | nulloptionalvideo_output_per_second_byobject | nulloptionalMap value specification
numberweb_fetch_per_1knumber | nulloptionalweb_search_per_1knumber | nulloptionalUnknown fields are rejected in this object.
Also accepts null.
model_metadataobject | nulloptionalModel facts keyed by selected ID. Absent fields inherit compatible catalog defaults; nested nulls remain unknown. A null model item resets its saved overrides to the catalog.
Map value specification
cachingobject | nulloptionalObject fields
min_cacheable_tokensinteger | nulloptionalsupportstring | nulloptional"supported""unsupported""conditional""unknown"nullsupported_ttlsarray | nulloptionalUnknown fields are rejected in this object.
capabilitiesobject | nulloptionalObject fields
supports_json_modeboolean | nulloptionalsupports_json_schemaboolean | nulloptionalsupports_parallel_tool_callsboolean | nulloptionalsupports_streamingboolean | nulloptionalsupports_tool_callingboolean | nulloptionalUnknown fields are rejected in this object.
input_formatsarray | nulloptionalinput_modalitiesarray | nulloptionallifecycleobject | nulloptionalObject fields
retirement_datestring | nulloptionalstatusstring | nulloptional"unknown""preview""stable""deprecated""retired"nullUnknown fields are rejected in this object.
limitsobject | nulloptionalObject fields
context_window_tokensinteger | nulloptionalmax_input_tokensinteger | nulloptionalmax_output_tokensinteger | nulloptionalmax_reasoning_tokensinteger | nulloptionalUnknown fields are rejected in this object.
output_formatsarray | nulloptionaloutput_modalitiesarray | nulloptionalprovenanceobject | nulloptionalObject fields
last_verified_atstring | nulloptionalsourcestring | nulloptional"manual""provider_api""catalog"nullsource_urlstring | nulloptionalupdated_atstring | nulloptionalUnknown fields are rejected in this object.
reasoning_tokens_in_output_budgetboolean | nulloptionalsupported_reasoning_effortsarray | nulloptionaltagsobject | nulloptionalAt most 64 active tags including the canonical identity preset, plus 1024 stored null clears. Null custom tags are hidden from public views; canonical_model:null resets the identity to its catalog default or model ID.
Map value specification
Variant 1 string
stringVariant 2 boolean
booleanVariant 3 number
numberVariant 4 array | null
array | nullAlso accepts null.
temperatureobject | nulloptionalObject fields
conditionsstring | nulloptionaldefaultnumber | nulloptionalmaxnumber | nulloptionalminnumber | nulloptionalsupportstring | nulloptional"supported""unsupported""conditional""unknown"nullUnknown fields are rejected in this object.
upstream_limitsobject | nulloptionalObject fields
input_tpminteger | nulloptionalmax_inflight_requestsinteger | nulloptionaloutput_tpminteger | nulloptionalrpminteger | nulloptionalshared_quota_pool_idsarray | nulloptionaltotal_tpminteger | nulloptionalUnknown fields are rejected in this object.
Unknown fields are rejected in this object.
model_metadata_resetmap<string, array<string>>optionalDotted metadata paths per selected model whose stored override is removed, so the catalog default shows through again. Distinct from null (= unknown).
Map value specification
array<string>provider_namestringrequiredProvider type; immutable.
"openai""azureopenai""general""anthropic""anthropic_messages""anthropic_messages_bedrock""anthropic_messages_azure""deepseek""vertex_ai""gemini_chatcompletions""oracle""openai_responses""openai_responses_azure""oracle_responses""openai_assistants""openai_assistants_azure""openai_realtime""openai_realtime_azure""bedrock""bedrock_embeddings""cohere_rerank""bedrock_rerank""jina_rerank""voyage_rerank""general_rerank""sarvam""mistral""xai""xai_responses""cerebras""typesafe""groq""perplexity""cohere"provider_settingsobjectoptionalSettings for the chosen provider type; required credentials depend on it and are validated against the merged configuration. Secret values are never returned.
Object fields
anthropic_versionstringoptionalAnthropic API version header.
api_keystringoptionalProvider API key. Write-only.
auth_typestringoptionalAuthentication mode for providers that support several.
aws_access_keystringoptionalSecret. Write-only.
aws_auth_modestringoptionalstatic (access keys) or assume_role.
aws_bedrock_api_keystringoptionalSecret. Write-only.
aws_bedrock_chat_apistringoptionalaws_bedrock_endpointstringoptionalaws_bedrock_openai_pathstringoptionalaws_external_idstringoptionalSecret. Write-only.
aws_regionstringoptionalaws_role_arnstringoptionalaws_role_session_namestringoptionalaws_secret_keystringoptionalSecret. Write-only.
aws_session_duration_secondsintegeroptionalAssumed-role session length, 900-43200.
aws_session_tokenstringoptionalSecret. Write-only.
azure_api_versionstringoptionalAzure API version.
azure_auth_headerstringoptionalAzure providers: the header the key is sent in. Omit (or api-key) for api-key, authorization_bearer for 'Authorization: Bearer <key>', or a header name such as Ocp-Apim-Subscription-Key (the raw key is sent in it).
azure_endpointstringoptionalAzure resource endpoint, or a custom API base ending in /deployments (e.g. an API Management route).
base_urlstringoptionalEndpoint base URL for OpenAI-compatible and self-hosted providers.
gcp_project_idstringoptionalgcp_regionstringoptionalgpu_connector_idstringoptionaloci_compartment_idstringoptionaloci_fingerprintstringoptionaloci_private_keystringoptionalSecret. Write-only.
oci_private_key_passphrasestringoptionalSecret. Write-only.
oci_project_idstringoptionaloci_regionstringoptionaloci_session_tokenstringoptionalSecret. Write-only.
oci_tenancy_idstringoptionaloci_user_idstringoptionalpreferred_upstream_apistringoptionalPrefer another endpoint of the client's API family.
remote_connector_idstringoptionalservice_account_jsonstringoptionalJSON-encoded Google service account document. Write-only.
upstream_apisarray<string>optionalOther wire APIs this upstream also serves.
Array item specification
stringuse_outbound_ipsboolean | string | nulloptionalThis provider's own Quilr outbound IP setting: a region code calls it from that region's outbound IPs (listed by GET /outbound-ips), true from the account's region, false calls it directly, null or omitted follows the account-wide setting (/outbound-ips). Refused for a provider linked to a connector, and for one whose endpoint is not a public host over https on port 443.
truefalse"us""eu""in"nullUnknown fields are rejected in this object.
selected_modelsarray<string>optionalArray item specification
stringtagsobject | nulloptionalMap value specification
Variant 1 string
stringVariant 2 boolean
booleanVariant 3 number
numberVariant 4 array | null
array | nullAlso accepts null.
tags_resetarray<object>optionalReturn provider tag presets to their derived/default values. geo is derived at read time from the region (us|eu|uk|ca|apac|jp|au|in|sa|me|global); tags.geo: null instead clears it to unknown and stops derivation. Reads add tag_sources {provider, models} naming each tag's source (derived|manual|catalog).
Array item specification
objectValues: "region""service_tier""geo"
upstream_limitsobject | nulloptionalObject fields
input_tpminteger | nulloptionalmax_inflight_requestsinteger | nulloptionaloutput_tpminteger | nulloptionalrpminteger | nulloptionalshared_quota_pool_idsarray | nulloptionaltotal_tpminteger | nulloptionalUnknown fields are rejected in this object.
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers' \
--header 'Authorization: Bearer <management-key>' \
--header 'Idempotency-Key: create-support-bot-001' \
--header 'Content-Type: application/json' \
--data '{
"label": "Bedrock US",
"provider_name": "bedrock",
"provider_settings": {
"aws_auth_mode": "assume_role",
"aws_external_id": "<external-id>",
"aws_region": "us-east-1",
"aws_role_arn": "arn:aws:iam::123456789012:role/gateway"
},
"selected_models": [
"anthropic.claude-sonnet-4-20250514-v1:0"
],
"tags": {
"region": "us-east-1"
}
}'
Authentication, errors & retry rules Try it in the playground
/providers/available-modelsDiscover models for draft settings
Lists the models the upstream offers for draft settings, before the provider is saved. `validate: true` also probes every listed model (slower, can incur upstream usage). Providers that cannot list models return outcome manual_entry. Nothing is saved.
providers:writeFull request body specification application/json
provider_namestringrequiredprovider_settingsobjectoptionalDraft settings, validated like a provider save. On a stored provider they merge onto the saved settings; a blank secret keeps the stored value. Never persisted.
validatebooleanoptionalAlso probe every listed model (slower; can incur upstream usage).
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers/available-models' \
--header 'Authorization: Bearer <management-key>' \
--header 'Content-Type: application/json' \
--data '{
"provider_name": "openai",
"provider_settings": {
"api_key": "<provider-api-key>"
},
"validate": false
}'
Authentication, errors & retry rules Try it in the playground
/providers/test-settingsTest draft provider settings
Tests settings for a provider that does not exist yet, before saving it: a connection check plus one probe per listed model. Nothing is saved. Outcomes include timeout and skipped (with a reason code) in addition to passed, failed and unsupported.
providers:writeFull request body specification application/json
modelsarray<string>optionalArray item specification
stringprovider_namestringrequiredprovider_settingsobjectoptionalDraft settings, validated like a provider save. On a stored provider they merge onto the saved settings; a blank secret keeps the stored value. Never persisted.
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers/test-settings' \
--header 'Authorization: Bearer <management-key>' \
--header 'Content-Type: application/json' \
--data '{
"models": [
"gpt-4.1-mini"
],
"provider_name": "openai",
"provider_settings": {
"api_key": "<provider-api-key>"
}
}'
Authentication, errors & retry rules Try it in the playground
/providers/{label}Delete a shared provider
Deletes the provider. Refused with 409 provider_in_use while any app attaches it; detach it first. Send the quoted version from the latest read in If-Match.
providers:writePath, query & header parameters 2
label (path)stringrequiredShared-provider label, URL-encoded.
If-Match (header)stringrequiredQuoted version from the latest read of the resource. Prompt, attachment, conversion and rollback writes use the app version.
Full request body specification application/json
Unknown fields are rejected in this object.
curl --request DELETE \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers/Production%20OpenAI' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"'
Authentication, errors & retry rules Try it in the playground
/providers/{label}Read a shared provider
One shared provider with secret settings omitted. `version` is its ETag.
readPath, query & header parameters 1
label (path)stringrequiredShared-provider label, URL-encoded.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers/Production%20OpenAI' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/providers/{label}Update or disable a provider
Partial update. Omitted secret settings keep their stored value; `enabled: false` disables the provider for every app. `model_metadata_reset` and `tags_reset` return values to their catalog or derived defaults. Send the quoted version from the latest read in If-Match.
providers:writePath, query & header parameters 2
label (path)stringrequiredShared-provider label, URL-encoded.
If-Match (header)stringrequiredQuoted version from the latest read of the resource. Prompt, attachment, conversion and rollback writes use the app version.
Full request body specification application/json
Shared-provider configuration. Saves never call the upstream; use the test and available-models operations to check settings.
enabledbooleanoptionallabelstringoptionalTenant-unique display name; immutable.
model_costsmap<string, one of 2 variants>optionalMap value specification
ModelCost object
audio_input_per_1mnumber | nulloptionalaudio_input_per_secondnumber | nulloptionalaudio_input_per_second_byobject | nulloptionalMap value specification
numberaudio_output_per_1mnumber | nulloptionalaudio_output_per_secondnumber | nulloptionalaudio_output_per_second_byobject | nulloptionalMap value specification
numberbatch_multipliernumber | nulloptionalcache_per_1mnumber | nulloptionalDeprecated alias of cache_read_per_1m. Requests may send it (must equal cache_read_per_1m when both are sent); responses echo it equal to cache_read_per_1m whenever that is set, and it is never stored.
cache_read_per_1mnumber | nulloptionalcache_write_1h_per_1mnumber | nulloptionalcache_write_5m_per_1mnumber | nulloptionalcache_write_default_ttlstring | nulloptional"5m""1h""unpriced"nullcache_write_per_1mnumber | nulloptionalcode_execution_per_hournumber | nulloptionalcontainer_per_sessionnumber | nulloptionaldocument_image_input_per_imagenumber | nulloptionaldocument_image_input_per_image_byobject | nulloptionalMap value specification
numberfile_search_per_1knumber | nulloptionalgrounding_per_1knumber | nulloptionalimage_input_per_1mnumber | nulloptionalimage_input_per_imagenumber | nulloptionalimage_input_per_image_byobject | nulloptionalMap value specification
numberimage_output_per_1mnumber | nulloptionalimage_output_per_imagenumber | nulloptionalimage_output_per_image_byobject | nulloptionalMap value specification
numberinput_per_1mnumber | nullrequiredinput_per_1m_charactersnumber | nulloptionalinput_per_1m_characters_byobject | nulloptionalMap value specification
numberoutput_per_1mnumber | nullrequiredpages_per_1knumber | nulloptionalpages_per_1k_byobject | nulloptionalMap value specification
numberreasoning_per_1mnumber | nulloptionalregional_multipliersobject | nulloptionalObject fields
data_residencynumber | nulloptionalgeonumber | nulloptionalregionalnumber | nulloptionalus_onlynumber | nulloptionalUnknown fields are rejected in this object.
requests_per_1knumber | nulloptionalrequests_per_1k_byobject | nulloptionalMap value specification
numbersearch_units_per_1knumber | nulloptionalsearch_units_per_1k_byobject | nulloptionalMap value specification
numberservice_tier_multipliersobject | nulloptionalObject fields
fastnumber | nulloptionalflexnumber | nulloptionalprioritynumber | nulloptionalUnknown fields are rejected in this object.
text_input_per_requestnumber | nulloptionaltext_input_per_request_byobject | nulloptionalMap value specification
numbertiersarray | nulloptionalvideo_input_per_secondnumber | nulloptionalvideo_input_per_second_byobject | nulloptionalMap value specification
numbervideo_output_per_secondnumber | nulloptionalvideo_output_per_second_byobject | nulloptionalMap value specification
numberweb_fetch_per_1knumber | nulloptionalweb_search_per_1knumber | nulloptionalUnknown fields are rejected in this object.
Also accepts null.
model_metadataobject | nulloptionalModel facts keyed by selected ID. Absent fields inherit compatible catalog defaults; nested nulls remain unknown. A null model item resets its saved overrides to the catalog.
Map value specification
cachingobject | nulloptionalObject fields
min_cacheable_tokensinteger | nulloptionalsupportstring | nulloptional"supported""unsupported""conditional""unknown"nullsupported_ttlsarray | nulloptionalUnknown fields are rejected in this object.
capabilitiesobject | nulloptionalObject fields
supports_json_modeboolean | nulloptionalsupports_json_schemaboolean | nulloptionalsupports_parallel_tool_callsboolean | nulloptionalsupports_streamingboolean | nulloptionalsupports_tool_callingboolean | nulloptionalUnknown fields are rejected in this object.
input_formatsarray | nulloptionalinput_modalitiesarray | nulloptionallifecycleobject | nulloptionalObject fields
retirement_datestring | nulloptionalstatusstring | nulloptional"unknown""preview""stable""deprecated""retired"nullUnknown fields are rejected in this object.
limitsobject | nulloptionalObject fields
context_window_tokensinteger | nulloptionalmax_input_tokensinteger | nulloptionalmax_output_tokensinteger | nulloptionalmax_reasoning_tokensinteger | nulloptionalUnknown fields are rejected in this object.
output_formatsarray | nulloptionaloutput_modalitiesarray | nulloptionalprovenanceobject | nulloptionalObject fields
last_verified_atstring | nulloptionalsourcestring | nulloptional"manual""provider_api""catalog"nullsource_urlstring | nulloptionalupdated_atstring | nulloptionalUnknown fields are rejected in this object.
reasoning_tokens_in_output_budgetboolean | nulloptionalsupported_reasoning_effortsarray | nulloptionaltagsobject | nulloptionalAt most 64 active tags including the canonical identity preset, plus 1024 stored null clears. Null custom tags are hidden from public views; canonical_model:null resets the identity to its catalog default or model ID.
Map value specification
Variant 1 string
stringVariant 2 boolean
booleanVariant 3 number
numberVariant 4 array | null
array | nullAlso accepts null.
temperatureobject | nulloptionalObject fields
conditionsstring | nulloptionaldefaultnumber | nulloptionalmaxnumber | nulloptionalminnumber | nulloptionalsupportstring | nulloptional"supported""unsupported""conditional""unknown"nullUnknown fields are rejected in this object.
upstream_limitsobject | nulloptionalObject fields
input_tpminteger | nulloptionalmax_inflight_requestsinteger | nulloptionaloutput_tpminteger | nulloptionalrpminteger | nulloptionalshared_quota_pool_idsarray | nulloptionaltotal_tpminteger | nulloptionalUnknown fields are rejected in this object.
Unknown fields are rejected in this object.
model_metadata_resetmap<string, array<string>>optionalDotted metadata paths per selected model whose stored override is removed, so the catalog default shows through again. Distinct from null (= unknown).
Map value specification
array<string>provider_namestringoptionalProvider type; immutable.
"openai""azureopenai""general""anthropic""anthropic_messages""anthropic_messages_bedrock""anthropic_messages_azure""deepseek""vertex_ai""gemini_chatcompletions""oracle""openai_responses""openai_responses_azure""oracle_responses""openai_assistants""openai_assistants_azure""openai_realtime""openai_realtime_azure""bedrock""bedrock_embeddings""cohere_rerank""bedrock_rerank""jina_rerank""voyage_rerank""general_rerank""sarvam""mistral""xai""xai_responses""cerebras""typesafe""groq""perplexity""cohere"provider_settingsobjectoptionalSettings for the chosen provider type; required credentials depend on it and are validated against the merged configuration. Secret values are never returned.
Object fields
anthropic_versionstringoptionalAnthropic API version header.
api_keystringoptionalProvider API key. Write-only; omit or send an empty string to keep the stored value.
auth_typestringoptionalAuthentication mode for providers that support several.
aws_access_keystringoptionalSecret. Write-only; omit or send an empty string to keep the stored value.
aws_auth_modestringoptionalstatic (access keys) or assume_role.
aws_bedrock_api_keystringoptionalSecret. Write-only; omit or send an empty string to keep the stored value.
aws_bedrock_chat_apistringoptionalaws_bedrock_endpointstringoptionalaws_bedrock_openai_pathstringoptionalaws_external_idstringoptionalSecret. Write-only; omit or send an empty string to keep the stored value.
aws_regionstringoptionalaws_role_arnstringoptionalaws_role_session_namestringoptionalaws_secret_keystringoptionalSecret. Write-only; omit or send an empty string to keep the stored value.
aws_session_duration_secondsintegeroptionalAssumed-role session length, 900-43200.
aws_session_tokenstringoptionalSecret. Write-only; omit or send an empty string to keep the stored value.
azure_api_versionstringoptionalAzure API version.
azure_auth_headerstringoptionalAzure providers: the header the key is sent in. Omit (or api-key) for api-key, authorization_bearer for 'Authorization: Bearer <key>', or a header name such as Ocp-Apim-Subscription-Key (the raw key is sent in it).
azure_endpointstringoptionalAzure resource endpoint, or a custom API base ending in /deployments (e.g. an API Management route).
base_urlstringoptionalEndpoint base URL for OpenAI-compatible and self-hosted providers.
gcp_project_idstringoptionalgcp_regionstringoptionalgpu_connector_idstringoptionaloci_compartment_idstringoptionaloci_fingerprintstringoptionaloci_private_keystringoptionalSecret. Write-only; omit or send an empty string to keep the stored value.
oci_private_key_passphrasestringoptionalSecret. Write-only; omit or send an empty string to keep the stored value.
oci_project_idstringoptionaloci_regionstringoptionaloci_session_tokenstringoptionalSecret. Write-only; omit or send an empty string to keep the stored value.
oci_tenancy_idstringoptionaloci_user_idstringoptionalpreferred_upstream_apistringoptionalPrefer another endpoint of the client's API family.
remote_connector_idstringoptionalservice_account_jsonstringoptionalJSON-encoded Google service account document. Write-only; omit or send an empty string to keep the stored value.
upstream_apisarray<string>optionalOther wire APIs this upstream also serves.
Array item specification
stringuse_outbound_ipsboolean | string | nulloptionalThis provider's own Quilr outbound IP setting: a region code calls it from that region's outbound IPs (listed by GET /outbound-ips), true from the account's region, false calls it directly, null or omitted follows the account-wide setting (/outbound-ips). Refused for a provider linked to a connector, and for one whose endpoint is not a public host over https on port 443.
truefalse"us""eu""in"nullUnknown fields are rejected in this object.
selected_modelsarray<string>optionalArray item specification
stringtagsobject | nulloptionalMap value specification
Variant 1 string
stringVariant 2 boolean
booleanVariant 3 number
numberVariant 4 array | null
array | nullAlso accepts null.
tags_resetarray<object>optionalReturn provider tag presets to their derived/default values. geo is derived at read time from the region (us|eu|uk|ca|apac|jp|au|in|sa|me|global); tags.geo: null instead clears it to unknown and stops derivation. Reads add tag_sources {provider, models} naming each tag's source (derived|manual|catalog).
Array item specification
objectValues: "region""service_tier""geo"
upstream_limitsobject | nulloptionalObject fields
input_tpminteger | nulloptionalmax_inflight_requestsinteger | nulloptionaloutput_tpminteger | nulloptionalrpminteger | nulloptionalshared_quota_pool_idsarray | nulloptionaltotal_tpminteger | nulloptionalUnknown fields are rejected in this object.
Unknown fields are rejected in this object.
curl --request PATCH \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers/Production%20OpenAI' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"' \
--header 'Content-Type: application/json' \
--data '{
"enabled": false
}'
Authentication, errors & retry rules Try it in the playground
/providers/{label}/available-modelsDiscover provider models
Lists the models the upstream offers for a stored provider, optionally with draft settings merged on top. Nothing is saved; update `selected_models` separately.
providers:writePath, query & header parameters 1
label (path)stringrequiredShared-provider label, URL-encoded.
Full request body specification application/json
provider_settingsobjectoptionalDraft settings, validated like a provider save. On a stored provider they merge onto the saved settings; a blank secret keeps the stored value. Never persisted.
validatebooleanoptionalAlso probe every listed model (slower; can incur upstream usage).
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers/Production%20OpenAI/available-models' \
--header 'Authorization: Bearer <management-key>' \
--header 'Content-Type: application/json' \
--data '{
"validate": false
}'
Authentication, errors & retry rules Try it in the playground
/providers/{label}/testTest connection or model
Tests the stored configuration. `kind: model` sends one small request to a selected model; `kind: connection` probes the selected models (up to a fixed number) and reports each. Outcomes are passed, failed or unsupported (provider types outside `model_test_provider_types`). Probes can incur upstream usage. Nothing is saved.
providers:writePath, query & header parameters 1
label (path)stringrequiredShared-provider label, URL-encoded.
Full request body specification application/json
kindobjectrequired"connection""model"modelstringoptionalA selected model; required for kind model.
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers/Production%20OpenAI/test' \
--header 'Authorization: Bearer <management-key>' \
--header 'Content-Type: application/json' \
--data '{
"kind": "connection"
}'
Authentication, errors & retry rules Try it in the playground
/providers/{label}/test-settingsTest provider settings
Tests draft changes to a stored provider before saving them. Draft settings merge onto the stored ones; a blank secret keeps the stored value. With no body, tests the stored configuration. Nothing is saved.
providers:writePath, query & header parameters 1
label (path)stringrequiredShared-provider label, URL-encoded.
Full request body specification application/json
modelsarray<string>optionalArray item specification
stringprovider_settingsobjectoptionalDraft settings, validated like a provider save. On a stored provider they merge onto the saved settings; a blank secret keeps the stored value. Never persisted.
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/providers/Production%20OpenAI/test-settings' \
--header 'Authorization: Bearer <management-key>' \
--header 'Content-Type: application/json' \
--data '{
"models": [
"gpt-4.1"
],
"provider_settings": {
"base_url": "https://api.openai.com/v1"
}
}'
Authentication, errors & retry rules Try it in the playground
Review new models
When a provider starts offering a model after the gateway began watching it, the model is held for an admin decision. A provider with a model list serves only listed models, so a pending model is not callable until you approve it. Providers without a model list serve every model and are not reviewed, and models already offered when watching began are never listed.
- Decisions.
status: "approved"adds the models to the provider's model list and closes the reviews; for a shared provider you can sendmodel_costs(as on update a provider) in the same call.rejectedrejects pending models andpendingrestores rejected ones; neither changes what the provider serves. - Saves. Approving on a shared provider is the same save as updating the provider, and the response carries its new
provider_version(theIf-Matchfor your next PATCH). Approving on an app's own provider creates a new app configuration version, and returns409if the app changed meanwhile. A shared provider without a model list cannot be approved on (409). - Retries. Decisions need an
Idempotency-Key: a retry with the same key and body replays the first result for 24 hours. - Validation. Every model must be a reviewed model of this provider in a state the decision can leave (
422otherwise). A decision that already holds is accepted and changes nothing. - Background checks.
settingsin every read reports whether the gateway checks providers for new models in the background and how often.available: falsemeans reviews are not managed on this deployment.
export API="$MANAGEMENT_URL/llmgateway/management/v1"
auth=(-H "Authorization: Bearer $MANAGEMENT_KEY" -H 'Content-Type: application/json')
# Pending models across every provider
curl -s "$API/provider-model-reviews?status=pending" "${auth[@]}" \
| jq -r '.items[] | [.label, .app_name // "shared", .model_id] | @tsv'
# Approve one on a shared provider, with prices
curl -s -X POST "$API/provider-model-reviews/Production%20OpenAI/decisions" "${auth[@]}" \
-H 'Idempotency-Key: approve-gpt-5-2-mini-001' \
-d '{"status": "approved", "models": ["gpt-5.2-mini"], "model_costs": {"gpt-5.2-mini": {"input_per_1m": 0.25, "output_per_1m": 2.0}}}'
/provider-model-reviewsList new-model reviews
Models your providers started offering after the gateway began watching them, one item per model, with status pending, approved or rejected. A provider with a model list serves only listed models, so a pending model is not callable until approved. Providers without a model list serve every model and are not reviewed; models already offered when watching began are never listed. Filter by status, provider label or app (an app's own provider keys). Newest first; page with `limit` (1 to 200, default 50) and `cursor`. settings reports the background check switch.
readPath, query & header parameters 5
status (query)objectoptionalOnly models in this state; omit for all three.
"pending""approved""rejected"provider (query)stringoptionalExact provider label.
app (query)stringoptionalOnly providers this app holds with its own keys (case-insensitive name).
limit (query)integeroptionalPage size: 1 to 200, default 50.
cursor (query)stringoptionalnext_cursor from the previous page; send the same other parameters.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/provider-model-reviews?limit=50' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/provider-model-reviews/{label}Read one provider's new-model reviews
The last model listing of one provider and its pending, approved and rejected models. Without app_name the label names a shared provider; with app_name, a provider that app holds with its own keys.
readPath, query & header parameters 2
label (path)stringrequiredProvider label, URL-encoded: a shared provider's label, or with app_name the label of a provider that app holds with its own keys.
app_name (query)stringoptionalName of the app holding the provider with its own keys; omit for a shared provider.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/provider-model-reviews/Production%20OpenAI' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/provider-model-reviews/{label}/app-decisionsApprove or reject new models of an app's own provider
For a provider an app holds with its own keys: `{label}` is that provider's label and app_name the app. approved adds the models to that provider's model list in one versioned app save (a new configuration version; 409 if the app changed meanwhile), then closes the reviews. rejected and pending work as for shared providers. An app that uses shared providers has no own providers: decide on the shared provider instead. Writes need an Idempotency-Key: a retry with the same key and body replays the first result for 24 hours. Every model must be a reviewed model of this provider in a state the decision can leave (422 otherwise); a decision that already holds is accepted and changes nothing.
config:writePath, query & header parameters 2
label (path)stringrequiredThe app's own provider label, URL-encoded: the label of a provider the app named by app_name holds with its own keys (not a shared provider).
Idempotency-Key (header)stringrequiredUnique per logical write. A retry with the same key and body replays the original result for 24 hours; the same key with a different body is a 409.
Full request body specification application/json
app_namestringrequiredmodelsarray<string>requiredArray item specification
stringstatusobjectrequiredapproved: add to the app provider's model list (a new app configuration version) and close the review. rejected / pending as for shared providers.
"approved""rejected""pending"Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/provider-model-reviews/Production%20OpenAI/app-decisions' \
--header 'Authorization: Bearer <management-key>' \
--header 'Idempotency-Key: approve-gpt-5-2-mini-001' \
--header 'Content-Type: application/json' \
--data '{
"app_name": "Support Bot",
"models": [
"gpt-5.2-mini"
],
"status": "approved"
}'
Authentication, errors & retry rules Try it in the playground
/provider-model-reviews/{label}/decisionsApprove or reject new models of a shared provider
approved adds the models to the shared provider's model list (optionally with prices) through the same save as updating the provider, then closes the reviews; the response carries the provider's new version. A provider without a model list cannot be approved on (409). rejected rejects pending models; pending restores rejected ones. Neither changes what the provider serves. Writes need an Idempotency-Key: a retry with the same key and body replays the first result for 24 hours. Every model must be a reviewed model of this provider in a state the decision can leave (422 otherwise); a decision that already holds is accepted and changes nothing.
providers:writePath, query & header parameters 2
label (path)stringrequiredShared-provider label, URL-encoded.
Idempotency-Key (header)stringrequiredUnique per logical write. A retry with the same key and body replays the original result for 24 hours; the same key with a different body is a 409.
Full request body specification application/json
model_costsmap<string, object>optionalOptional prices for approved models, as on PATCH /providers/{label}.
Map value specification
audio_input_per_1mnumber | nulloptionalaudio_input_per_secondnumber | nulloptionalaudio_input_per_second_byobject | nulloptionalMap value specification
numberaudio_output_per_1mnumber | nulloptionalaudio_output_per_secondnumber | nulloptionalaudio_output_per_second_byobject | nulloptionalMap value specification
numberbatch_multipliernumber | nulloptionalcache_per_1mnumber | nulloptionalDeprecated alias of cache_read_per_1m. Requests may send it (must equal cache_read_per_1m when both are sent); responses echo it equal to cache_read_per_1m whenever that is set, and it is never stored.
cache_read_per_1mnumber | nulloptionalcache_write_1h_per_1mnumber | nulloptionalcache_write_5m_per_1mnumber | nulloptionalcache_write_default_ttlstring | nulloptional"5m""1h""unpriced"nullcache_write_per_1mnumber | nulloptionalcode_execution_per_hournumber | nulloptionalcontainer_per_sessionnumber | nulloptionaldocument_image_input_per_imagenumber | nulloptionaldocument_image_input_per_image_byobject | nulloptionalMap value specification
numberfile_search_per_1knumber | nulloptionalgrounding_per_1knumber | nulloptionalimage_input_per_1mnumber | nulloptionalimage_input_per_imagenumber | nulloptionalimage_input_per_image_byobject | nulloptionalMap value specification
numberimage_output_per_1mnumber | nulloptionalimage_output_per_imagenumber | nulloptionalimage_output_per_image_byobject | nulloptionalMap value specification
numberinput_per_1mnumber | nullrequiredinput_per_1m_charactersnumber | nulloptionalinput_per_1m_characters_byobject | nulloptionalMap value specification
numberoutput_per_1mnumber | nullrequiredpages_per_1knumber | nulloptionalpages_per_1k_byobject | nulloptionalMap value specification
numberreasoning_per_1mnumber | nulloptionalregional_multipliersobject | nulloptionalObject fields
data_residencynumber | nulloptionalgeonumber | nulloptionalregionalnumber | nulloptionalus_onlynumber | nulloptionalUnknown fields are rejected in this object.
requests_per_1knumber | nulloptionalrequests_per_1k_byobject | nulloptionalMap value specification
numbersearch_units_per_1knumber | nulloptionalsearch_units_per_1k_byobject | nulloptionalMap value specification
numberservice_tier_multipliersobject | nulloptionalObject fields
fastnumber | nulloptionalflexnumber | nulloptionalprioritynumber | nulloptionalUnknown fields are rejected in this object.
text_input_per_requestnumber | nulloptionaltext_input_per_request_byobject | nulloptionalMap value specification
numbertiersarray | nulloptionalvideo_input_per_secondnumber | nulloptionalvideo_input_per_second_byobject | nulloptionalMap value specification
numbervideo_output_per_secondnumber | nulloptionalvideo_output_per_second_byobject | nulloptionalMap value specification
numberweb_fetch_per_1knumber | nulloptionalweb_search_per_1knumber | nulloptionalUnknown fields are rejected in this object.
modelsarray<string>requiredArray item specification
stringstatusobjectrequiredapproved: add to the provider's model list and close the review (from pending or rejected). rejected: reject a pending model. pending: restore a rejected model.
"approved""rejected""pending"Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/provider-model-reviews/Production%20OpenAI/decisions' \
--header 'Authorization: Bearer <management-key>' \
--header 'Idempotency-Key: approve-gpt-5-2-mini-001' \
--header 'Content-Type: application/json' \
--data '{
"model_costs": {
"gpt-5.2-mini": {
"input_per_1m": 0.25,
"output_per_1m": 2
}
},
"models": [
"gpt-5.2-mini"
],
"status": "approved"
}'
Authentication, errors & retry rules Try it in the playground
Quota pools
A quota pool names an upstream ceiling that several providers or models share, such as one provider organization's tokens-per-minute limit used by two credentials. Pools are descriptive: they document limits and membership, and do not change routing or enforce limits.
- Register before you assign. A provider write that names an unregistered pool ID returns
400 invalid_providernaming the unknown IDs.GET /quota-poolsreturnsunregistered, the pool IDs that providers already reference but that were never registered; create a pool with thatpool_idto adopt it. - Membership lives on providers. Set
upstream_limits.shared_quota_pool_idson a provider, or on one model inmodel_metadata. Each pool'smemberslists the providers and{provider_label, model}pairs that reference it. - IDs and limits. New
pool_idvalues use lowercase letters, digits,.,_,:and-(up to 128 characters) and cannot change.limits(rpm,rpd,input_tpm,output_tpm,max_inflight_requestsand more) are positive integers;nullmeans unknown. PATCH merges limit keys. - Writes need
providers:write. Creation takes anIdempotency-Key; updates and deletes take the poolversioninIf-Match. Deleting a pool that still has members returns409 quota_pool_in_useunless you passdetach=true, which removes it from every member first.
/quota-poolsList quota pools
Registered pools with their member providers and models. `unregistered` lists pool IDs that providers reference but that were never registered; create one with that pool_id to adopt it.
readPath, query & header parameters 2
limit (query)integeroptionalPage size.
cursor (query)stringoptionalOpaque cursor from the previous page's next_cursor.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/quota-pools?limit=50' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/quota-poolsCreate a quota pool
Registers a pool of upstream limits shared by several providers or models. Limits are descriptive ceilings (null means unknown). Membership is set on providers, not here.
providers:writePath, query & header parameters 1
Idempotency-Key (header)stringrequiredUnique per logical write. A retry with the same key and body replays the original result for 24 hours; the same key with a different body is a 409.
Full request body specification application/json
descriptionstring | nulloptionallast_verified_atstring | nulloptionallimitsone of 2 variantsoptionalQuotaPoolLimits object
input_tpminteger | nulloptionalmax_inflight_requestsinteger | nulloptionaloutput_tpminteger | nulloptionalrpdinteger | nulloptionalrpminteger | nulloptionaltotal_tpminteger | nulloptionalUnknown fields are rejected in this object.
Also accepts null.
namestringrequiredpool_idstringrequiredImmutable. A new id must match ^[a-z0-9][a-z0-9._:-]{0,127}$; an unregistered legacy id already referenced by a provider may be adopted verbatim (no control characters, '/' or surrounding whitespace), so stored ids need not match.
sourceobjectoptional"manual""provider_docs""provider_api"source_urlstring | nulloptionalUnknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/quota-pools' \
--header 'Authorization: Bearer <management-key>' \
--header 'Idempotency-Key: create-support-bot-001' \
--header 'Content-Type: application/json' \
--data '{
"limits": {
"input_tpm": 2000000,
"rpm": 5000
},
"name": "OpenAI organization",
"pool_id": "openai-org-main"
}'
Authentication, errors & retry rules Try it in the playground
/quota-pools/{pool_id}Delete a quota pool
Deletes the pool. Refused with 409 quota_pool_in_use while providers or models reference it, unless detach=true, which first removes it from every member. Send the quoted version from the latest read in If-Match.
providers:writePath, query & header parameters 3
pool_id (path)stringrequireddetach (query)booleanoptionalRemove the pool from every member provider/model first (409 quota_pool_in_use otherwise).
If-Match (header)stringrequiredQuoted version from the latest read of the resource. Prompt, attachment, conversion and rollback writes use the app version.
Full request body specification application/json
Unknown fields are rejected in this object.
curl --request DELETE \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/quota-pools/openai-org-main' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"'
Authentication, errors & retry rules Try it in the playground
/quota-pools/{pool_id}Read a quota pool
One pool with its members. `version` is its ETag.
readPath, query & header parameters 1
pool_id (path)stringrequiredNo request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/quota-pools/openai-org-main' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/quota-pools/{pool_id}Update a quota pool
Partial update; omitted limit keys keep their value. `pool_id` is immutable. Send the quoted version from the latest read in If-Match.
providers:writePath, query & header parameters 2
pool_id (path)stringrequiredIf-Match (header)stringrequiredQuoted version from the latest read of the resource. Prompt, attachment, conversion and rollback writes use the app version.
Full request body specification application/json
descriptionstring | nulloptionallast_verified_atstring | nulloptionallimitsone of 2 variantsoptionalQuotaPoolLimits object
input_tpminteger | nulloptionalmax_inflight_requestsinteger | nulloptionaloutput_tpminteger | nulloptionalrpdinteger | nulloptionalrpminteger | nulloptionaltotal_tpminteger | nulloptionalUnknown fields are rejected in this object.
Also accepts null.
namestringoptionalpool_idstringoptionalImmutable. A new id must match ^[a-z0-9][a-z0-9._:-]{0,127}$; an unregistered legacy id already referenced by a provider may be adopted verbatim (no control characters, '/' or surrounding whitespace), so stored ids need not match.
sourceobjectoptional"manual""provider_docs""provider_api"source_urlstring | nulloptionalUnknown fields are rejected in this object.
curl --request PATCH \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/quota-pools/openai-org-main' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"' \
--header 'Content-Type: application/json' \
--data '{
"limits": {
"rpm": 10000
}
}'
Authentication, errors & retry rules Try it in the playground
Outbound IPs
Quilr outbound IPs give a provider's calls fixed source addresses per region that you allowlist on the provider. See Outbound IPs for the addresses and the console steps.
- Default for all providers.
GET /outbound-ipsreturnsenabled,regionandregions(each withcode,name,ipsandavailable).PUT /outbound-ipstakesenabled,regionor both, and needsconfig:write. Region codes areus,euandin. Changes reach every gateway server withinapplies_within_seconds. - One provider. Set
provider_settings.use_outbound_ipson the provider: a region code for that region,truefor the default's region,falsefor direct, ornullto follow the default. It always wins over the default. - Refused routes.
use_outbound_ipsis refused with422for a provider linked to a remote connector or GPU server, and for one whose endpoint is not a public host overhttpson port 443. - No fallback. A call that can't go through the chosen region fails with
503 outbound_ips_unreachable; it is never sent directly.
/outbound-ipsRead the outbound IP setting
The account-wide Quilr outbound IP setting and every region's addresses. A provider's own use_outbound_ips setting (in its provider_settings) always wins: a region code or true calls it from the Quilr outbound IPs, false calls it directly. A provider without one follows this account-wide setting; with neither set, the provider is called directly. Outbound IPs work for a provider on a public host over https on port 443; a provider linked to a connector keeps its connector. region picks which Quilr region's outbound IPs are used (GET lists every region's addresses). The setting is kept per region.
readNo request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/outbound-ips' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/outbound-ipsTurn Quilr outbound IPs on or off
Set the account-wide setting: enabled true, false, or null to clear it, and the region. A provider's own use_outbound_ips setting (in its provider_settings) always wins: a region code or true calls it from the Quilr outbound IPs, false calls it directly. A provider without one follows this account-wide setting; with neither set, the provider is called directly. Outbound IPs work for a provider on a public host over https on port 443; a provider linked to a connector keeps its connector. region picks which Quilr region's outbound IPs are used (GET lists every region's addresses). The setting is kept per region.
config:writeFull request body specification application/json
enabledboolean | nulloptionaltrue: every provider without a use_outbound_ips setting of its own calls out from the Quilr outbound IPs. false or null: those providers are called directly.
regionstring | nulloptionalThe region whose Quilr outbound IPs are used; null: the gateway's own region.
"us""eu""in"nullUnknown fields are rejected in this object.
curl --request PUT \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/outbound-ips' \
--header 'Authorization: Bearer <management-key>' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"region": "in"
}'
Authentication, errors & retry rules Try it in the playground
Full app configuration input
Use PATCH /llmgateway/management/v1/apps/{app_name} with the current app ETag. The same settings sections are accepted during app creation. The reference below uses the implemented wire names.
Partial updates
Omitted fields preserve stored values. Unknown top-level and section fields are rejected. Nested maps such as category actions and sensitivities use the existing gateway merge semantics; an empty map is not a global reset. Lists such as tags, routing groups and custom-definition selections replace the list. [] clears a list where an empty list is supported; a provider-backed app must retain providers.
Only timeout, concurrency_per_minute, rate_limit, allowed_source_ips, jwt_auth and alerting accept a null reset at the public field level. Other fields, including token_limits, reject null. App-level timeout is a nonnegative integer in seconds.
When updating alerting, send its complete configuration, including the HTTPS URL for every submitted webhook. Omit the entire field to preserve it. Redacted webhook URLs from a read cannot be reused as credentials.
Configuration map
detection.enabled_categories maps existing built-in category IDs, or already-selected custom IDs, to booleans. Use detection.custom_definitions to select existing tenant definitions by ID; new regex/EDM/semantic/intent content is not accepted.
JWT authentication
Use access.jwt_auth with allowed_issuers, allowed_client_ids, an RSA public_key_pem, optional kid and optional enabled. Enabled configuration requires nonempty issuer/client-ID lists. Saves do not fetch JWKS URLs. null, {} or { "enabled": false } disables JWT authentication.
Settings under QuilrQL
Policy-governed changes can save and return inactive_under_quilrql, including affected fields and active_revision. Shared-provider credentials/availability, prompt contents and whole-app availability have independent runtime effects. See QuilrQL behavior, including the allowed-models default for eligible new apps.
Complete PATCH schema
AppPatchaccessobjectoptionalObject fields
allowed_source_ipsone of 3 variantsoptionalVariant 1 array<string>
array<string>Variant 2 object
enabledbooleanoptionalipsarray<string>optionalArray item specification
stringUnknown fields are rejected in this object.
Also accepts null.
allowed_user_domainsarray<string>optionalArray item specification
stringallowed_user_emailsarray<string>optionalArray item specification
stringenforce_conversation_idbooleanoptionalenforce_identitybooleanoptionalidentity_header_modebooleanoptionalidentity_token_headersarray<string>optionalArray item specification
stringidentity_token_oid_fallbackbooleanoptionaljwt_authobject | nulloptionalJwtAuth object
allowed_audiencesarray | nulloptionalOmitted or null keeps the stored list.
allowed_client_idsarray<string>optionalArray item specification
stringallowed_issuersarray<string>optionalArray item specification
stringemail_claimstring | nulloptionalClaim read first for the user's email.
enabledbooleanoptionalkidstringoptionalpublic_key_pemstringoptionalRSA public key (PEM). Required when enabling; this API does not fetch JWKS URLs.
subject_fallbackboolean | nulloptionalUse the token subject as identity when it has no email.
verify_audienceboolean | nulloptionalRequires a non-empty allowed_audiences. Omitted keeps the stored value (default false).
Unknown fields are rejected in this object.
Also accepts null.
Unknown fields are rejected in this object.
alertingobject | nulloptionalAlerting object
app_levelobjectoptionalObject fields
cooldown_minutesintegeroptionalenabledbooleanoptionalfailure_rate_thresholdnumberoptionalPercentage.
minimum_requestsintegeroptionalnotify_on_recoverybooleanoptionalwindow_minutesintegeroptionalchannelsobjectoptionalObject fields
emailsarray<string>optionalArray item specification
stringwebhooksarray<object>optionalArray item specification
idstringoptionallabelstringoptionaltypestringoptional"slack""generic"urlstringrequiredHTTPS webhook URL, required for every submitted webhook.
provider_levelobjectoptionalObject fields
cooldown_minutesintegeroptionalenabledbooleanoptionalfailure_rate_thresholdnumberoptionalPercentage.
minimum_requestsintegeroptionalnotify_on_recoverybooleanoptionalwindow_minutesintegeroptionalAlso accepts null.
detectionobjectoptionalObject fields
attachment_scanningobjectoptionalRequest attachment scanning (images, PDFs, office documents): limits, text extraction and actions. Off by default. Partial updates merge. Under QuilrQL the policy decides enabled; attachments.* effects override the other fields (type_actions per kind).
Object fields
enabledbooleanoptionalimage_classificationbooleanoptionalmax_file_bytesintegeroptionalmax_filesintegeroptionalmax_request_bytesintegeroptionalocrobjectoptional"off""no_text_layer""always"ocr_scriptsarray<object>optionalArray item specification
objectValues: "latin""cjk""korean""cyrillic""arabic""devanagari""tamil""telugu""thai""greek"
on_limit_violationobjectoptional"monitor""strip""block"on_macrosobjectoptional"monitor""strip""block"on_unscannableobjectoptionalWhat happens to an attachment the file itself makes unscannable: encrypted, unparseable, a remote URL or a provider file ID. Scan failures (timeouts, scanner errors, text past the scan limit) always fail open and never use this action.
"monitor""strip""block"pdf_max_pagesintegeroptionalredact_documents_as_textbooleanoptionaltext_extractionbooleanoptionaltype_actionsobjectoptionalPer detected kind: allow, strip or block. Kinds not listed are allowed; updates merge per kind and {} resets every kind to allow.
Object fields
archiveobjectoptional"allow""strip""block"audioobjectoptional"allow""strip""block"documentobjectoptional"allow""strip""block"imageobjectoptional"allow""strip""block"otherobjectoptional"allow""strip""block"pdfobjectoptional"allow""strip""block"presentationobjectoptional"allow""strip""block"spreadsheetobjectoptional"allow""strip""block"textobjectoptional"allow""strip""block"videoobjectoptional"allow""strip""block"Unknown fields are rejected in this object.
Unknown fields are rejected in this object.
category_actionsmap<string, string>optionalCategory ID to action.
Map value specification
stringAdversarial detections have no redactable spans; actions they cannot apply are rejected.
Values: "monitor""partial-redact""tokenize""redact""block"
category_scopesmap<string, string>optionalMap value specification
stringValues: "request""response""both"
category_sensitivitiesmap<string, array<string>>optionalMap value specification
array<string>custom_definitionsarray<object>optionalReplaces the whole selection; [] clears it. Never deletes definitions.
Array item specification
actionstringoptionalAdversarial detections have no redactable spans; actions they cannot apply are rejected.
"monitor""partial-redact""tokenize""redact""block"definition_idstringrequiredStable ID from GET /custom-definitions.
enabledbooleanoptionalscopestringoptional"request""response""both"sensitivitystringoptional"low""medium""high"Unknown fields are rejected in this object.
data_risk_actionstringoptional"block""redact""partial-redact""tokenize""monitor"edm_pattern_sensitivitiesmap<string, string>optionalMap value specification
stringValues: "low""medium""high"
enabled_categoriesmap<string, boolean>optionalCatalog category or subcategory IDs mapped to enabled state. Unknown IDs are rejected.
Map value specification
booleanguardian_agentobjectoptionalPartial update of Guardian branches; set a branch's enabled to false to turn it off. Model-backed checks follow what the deployment supports.
Object fields
coding_helpersobjectoptionalObject fields
dependency_security_checkbooleanoptionalenabledbooleanoptionallatest_version_suggestionsbooleanoptionalenabledbooleanoptionaltask_adherenceobjectoptionalObject fields
actionstringoptional"nudge""block"agent_purposestringoptionalenabledbooleanoptionalguardian_agent_promptstringoptionalsensitivitystringoptional"low""medium""high"hallucination_check_actionstringoptional"block""monitor"hallucination_check_risk_levelstringoptionalhallucination_check_score_thresholdnumberoptionalis_hallucination_check_enabledbooleanoptionalsub_category_actionsmap<string, map<string, string>>optionalCategory ID to subcategory name to action.
Map value specification
map<string, string>sub_category_sensitivitiesmap<string, map<string, string>>optionalMap value specification
map<string, string>Unknown fields are rejected in this object.
enabledbooleanoptionallimitsobjectoptionalObject fields
concurrency_per_minuteinteger | nulloptionalmodel_rate_limitsarray<object>optionalArray item specification
concurrency_per_minuteinteger | nulloptionalRequest admissions per 60 seconds.
modelstringrequiredExact configured model identifier.
provider_labelstringrequiredExact shared-provider label.
rate_limitobject | nulloptionalRateLimit object
durationstringrequired"minute""hour""day"valueintegerrequiredMaximum events in the window; 0 disables.
Also accepts null.
timeoutnumber | nulloptionalSeconds.
token_limitsobject | nulloptionalTokenLimits object
inputobject | nulloptionalRateLimit object
durationstringrequired"minute""hour""day"valueintegerrequiredMaximum events in the window; 0 disables.
Also accepts null.
max_per_requestinteger | nulloptionalMaximum input tokens per request; 0 disables.
outputobject | nulloptionalRateLimit object
durationstringrequired"minute""hour""day"valueintegerrequiredMaximum events in the window; 0 disables.
Also accepts null.
Also accepts null.
rate_limitobject | nulloptionalRateLimit object
durationstringrequired"minute""hour""day"valueintegerrequiredMaximum events in the window; 0 disables.
Also accepts null.
rate_limit_per_minuteintegeroptionaltimeoutinteger | nulloptionaltoken_limitsobjectoptionalObject fields
inputobject | nulloptionalRateLimit object
durationstringrequired"minute""hour""day"valueintegerrequiredMaximum events in the window; 0 disables.
Also accepts null.
max_per_requestinteger | nulloptionalMaximum input tokens per request; 0 disables.
outputobject | nulloptionalRateLimit object
durationstringrequired"minute""hour""day"valueintegerrequiredMaximum events in the window; 0 disables.
Also accepts null.
Unknown fields are rejected in this object.
promptsobjectoptionalObject fields
require_system_from_storebooleanoptionaluniversal_system_promptobjectoptionalPrepended to the system prompt of every request when enabled; partial objects merge onto the stored value.
Object fields
contentstringoptionalenabledbooleanoptionalUnknown fields are rejected in this object.
Unknown fields are rejected in this object.
provider_labelsarray<string>optionalArray item specification
stringroutingobjectoptionalObject fields
custom_routingarray<object>optionalArray item specification
groupstringoptional"anthropic_messages""bedrock_runtime""chat_completion""responses""vertex_ai"is_publishedbooleanrequiredmodelsarray<object>requiredArray item specification
credential_sourcestringoptionallabelstringoptionalmodelstringrequiredprovider_namestringrequiredtypestringrequired"High_Context_Request""Low_Context_Request""Medium_Context_Request"routing_groupsarray<object>optionalArray item specification
group_kindstringoptionalClient API family the group serves.
"chat_completion""anthropic_messages""vertex_ai""responses""realtime""bedrock_runtime"group_namestringrequiredmodelsarray<object>requiredArray item specification
credential_sourcestringoptionalLabel of a shared provider attached to the app; inline credentials are not accepted.
model_namestringrequiredprovider_namestringrequiredweightnumberrequiredrouting_thresholdsobjectoptionalWord-count boundaries of context routes: 0 <= low_max_words <= medium_max_words.
Object fields
low_max_wordsintegerrequiredmedium_max_wordsintegerrequiredUnknown fields are rejected in this object.
token_based_routing_groupsarray<object>optionalArray item specification
group_kindstringoptionalClient API family the group serves.
"chat_completion""anthropic_messages""vertex_ai""responses""realtime""bedrock_runtime"group_namestringrequiredmodelsarray<object>requiredArray item specification
credential_sourcestringoptionalLabel of a shared provider attached to the app; inline credentials are not accepted.
model_namestringrequiredprovider_namestringrequiredweightnumberrequiredUnknown fields are rejected in this object.
self_serviceobjectoptionalObject fields
enable_self_servicebooleanoptionalself_serviceobjectoptionalSelf-service configuration, including access-control roles. A save replaces the whole object (send every field you keep), except owners (kept when omitted) and origin (read-only). Omit to keep; null is not accepted.
Object fields
access_controlobject | nulloptionalVariant 1 object
self_service_viewerobjectoptionalDeny rules win. Referencing a group never changes its membership.
Object fields
allow_allbooleanoptionalallow_emailsarray<string>optionalArray item specification
stringallow_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
deny_emailsarray<string>optionalArray item specification
stringdeny_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
settings_update_directobjectoptionalDeny rules win. Referencing a group never changes its membership.
Object fields
allow_allbooleanoptionalallow_emailsarray<string>optionalArray item specification
stringallow_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
deny_emailsarray<string>optionalArray item specification
stringdeny_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
settings_update_requesterobjectoptionalDeny rules win. Referencing a group never changes its membership.
Object fields
allow_allbooleanoptionalallow_emailsarray<string>optionalArray item specification
stringallow_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
deny_emailsarray<string>optionalArray item specification
stringdeny_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
show_api_keyobjectoptionalDeny rules win. Referencing a group never changes its membership.
Object fields
allow_allbooleanoptionalallow_emailsarray<string>optionalArray item specification
stringallow_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
deny_emailsarray<string>optionalArray item specification
stringdeny_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
show_logs_for_all_usersobjectoptionalDeny rules win. Referencing a group never changes its membership.
Object fields
allow_allbooleanoptionalallow_emailsarray<string>optionalArray item specification
stringallow_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
deny_emailsarray<string>optionalArray item specification
stringdeny_smart_groupsarray<string>optionalArray item specification
stringExisting smart-group name.
version1optionalAlso accepts null.
max_api_key_ttl_daysinteger | nulloptionalLongest lifetime, in days, of a personal API key of this app. When set, every new key needs an expiry within it. null or omitted: no limit.
originobjectoptionalPresent only on apps a person created from a blueprint in self-service. Set by the server; read-only (never changed by a save).
Object fields
blueprint_appstringoptionalThe app it was copied from.
blueprint_config_versioninteger | nulloptionalThe blueprint's configuration version at the copy.
created_atstring | nulloptionalcreated_bystringoptionalEmail of the person who created it.
kindstringoptional"blueprint"ownersarray<string>optionalEmails of the app's owners: they review its budget and access requests (and own it when a person created it from a blueprint). A list replaces them; omitted or empty, the stored owners are kept. To remove every owner use PUT /apps/{app_name}/self-service-owners with [].
Array item specification
stringUnknown fields are rejected in this object.
smart_group_policiesarray<object>optionalArray item specification
actionsobjectoptionalObject fields
data_risk_actionstringoptionalAdversarial detections have no redactable spans; actions they cannot apply are rejected.
"monitor""partial-redact""tokenize""redact""block"hallucination_check_actionstringoptional"block""monitor"category_actionsmap<string, string>optionalMap value specification
stringAdversarial detections have no redactable spans; actions they cannot apply are rejected.
Values: "monitor""partial-redact""tokenize""redact""block"
category_scopesmap<string, string>optionalMap value specification
stringValues: "request""response""both"
category_sensitivitiesmap<string, array<string>>optionalMap value specification
array<string>enabledbooleanoptionalenabled_categoriesmap<string, boolean>optionalCatalog category or subcategory IDs to enabled state.
Map value specification
booleangroup_namestringrequiredsub_category_actionsmap<string, map<string, string>>optionalMap value specification
map<string, string>sub_category_sensitivitiesmap<string, map<string, string>>optionalMap value specification
map<string, string>Unknown fields are rejected in this object.
tagsarray<string>optionalArray item specification
stringtransformationsobjectoptionalObject fields
response_cacheobjectoptionalResponse cache for non-streaming requests. Partial updates merge. Under QuilrQL the policy decides enabled, match and similarity.
Object fields
enabledbooleanoptionalflushbooleanoptionaltrue discards every cached response of the app.
matchobjectoptionalexact: same prompt after whitespace cleanup. normalized: also ignores case, repeated spaces, punctuation around words and a fixed set of filler words. semantic: also matches a reworded last user message (chat and Anthropic Messages). Exact and normalized repeats skip every guardrail; a reworded match is served only after request guardrails pass the new prompt and skips the model call and response guardrails. Semantic can answer for a different name, title, username or filename in templated prompts: use it for human-typed FAQ or helpdesk apps, not programmatic pipelines.
"exact""normalized""semantic"max_size_mbintegeroptionalscopeobjectoptional"app""user"similarityobjectoptionalHow close a semantic match must be. Used only when match is semantic.
"narrow""balanced""wider"ttl_secondsintegeroptionalUnknown fields are rejected in this object.
token_savingobjectoptionalRequest-body transforms that reduce input tokens.
Object fields
base64_blob_elisionbooleanoptionalhtml_to_textbooleanoptionaljson_minificationbooleanoptionalmarkdown_to_textbooleanoptionalsmart_json_compressionbooleanoptionaltext_compressionbooleanoptionaltool_output_cleanupbooleanoptionalUnknown fields are rejected in this object.
Unknown fields are rejected in this object.
Unknown fields are rejected in this object.
Example: guardrails, limits and an existing group
{
"detection": {
"data_risk_action": "redact",
"enabled_categories": {"data_risk_category_pii": true},
"custom_definitions": [{
"definition_id": "employee_id",
"enabled": true,
"action": "block",
"scope": "request"
}],
"scan_images": true,
"scan_images_scope": "request"
},
"limits": {
"timeout": 60,
"rate_limit": {"value": 1000, "duration": "minute"},
"token_limits": {"max_per_request": 16000}
},
"smart_group_policies": [{
"group_name": "engineering",
"enabled": true,
"actions": {"data_risk_action": "monitor"}
}],
"transformations": {"token_saving": {"smart_json_compression": true}},
"prompts": {"require_system_from_store": true}
}
This assumes employee_id and engineering exist in the authenticated tenant. Query the catalogs first. OCR availability follows the deployment's model capability.
Example: weighted routing
{
"routing": {
"routing_groups": [{
"group_name": "support-chat",
"group_kind": "chat_completion",
"models": [
{"provider_name": "openai", "credential_source": "Production OpenAI", "model_name": "gpt-4.1-mini", "weight": 80},
{"provider_name": "openai", "credential_source": "Backup OpenAI", "model_name": "gpt-4.1-mini", "weight": 20}
]
}],
"custom_routing": [],
"routing_thresholds": {"low_max_words": 200, "medium_max_words": 1000}
}
}
Both providers must already be attached with compatible models. Weights sum to 100. routing_groups and token_based_routing_groups are separate lists; omission preserves the other list. Use shared-provider references rather than inline credentials.
Catalogs and configuration history
Read existing tenant resources and inspect configuration changes. These endpoints cover configuration and catalogs. For operational reporting, see the Usage API and the Monitoring API.
Catalogs
GET /custom-definitions supports limit and cursor; a q search filter is Not Generally Available. Read one definition by definition_id (the same value as edm_id): use it in the path and as definition_id when selecting it in an app. Existing definitions can be referenced in app configuration; regex/EDM/semantic/intent authoring is Not Generally Available through these APIs.
Smart groups, their rank and virtual groups have their own page: the Smart groups API.
Configuration history
List versions with /apps/{app_name}/versions; read one with /versions/{version_id}. Individual reads return version_record, with metadata and redacted previous_config/new_config snapshots when present. Unsafe legacy diffs are omitted.
Rollback requires the current app ETag and Idempotency-Key. It restores eligible settings as a new configuration change. It cannot rename the app, alter credential expiry, mutate provider/definition resources, restore inline credentials, change JWT keys or restore internal-only settings. Routing/group references are revalidated. App rollback does not roll back policy revisions.
Audit
GET /audit returns tenant management events, newest first, with event_id, actor, operation, resource, request_id, result, created_at and changes. Rejected writes are recorded with their error code, and provider tests and discovery with their outcome only. created_at uses Unix seconds. Events are kept for 90 days. New events never invalidate a cursor; they appear on a fresh listing. Filter with actor (a management key id or administrator), operation (for example provider_update), resource, and since / until (RFC 3339 time, a date meaning UTC midnight, or epoch seconds). Unknown parameters are 400.
Operation recovery
After 503 operation_pending, retain error.operation_id. Read /operations/{operation_id} with read using the same key that initiated the operation. The response contains operation_id, state, created_at and request_id.
POST /operations/{operation_id}/recover with config:write retries a saved configuration write and audit. It refuses to overwrite a later different configuration. An already completed operation returns its ID/state; a recovered configuration can also include app and warnings.
App/provider/credential creation recovers by retrying the original POST and Idempotency-Key, not the recovery endpoint. Read the retry contract before automating recovery.
/custom-definitionsList custom definitions
Custom detection definitions that apps can select by `edm_id` in detection.custom_definitions. Definitions are authored in the console; this API only references them.
readPath, query & header parameters 2
limit (query)integeroptionalPage size.
cursor (query)stringoptionalOpaque cursor from the previous page's next_cursor.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/custom-definitions?limit=50' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/custom-definitions/{definition_id}Read a custom definition
One custom definition by its stable ID.
readPath, query & header parameters 1
definition_id (path)stringrequiredNo request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/custom-definitions/employee_id' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/versionsList app configuration versions
Saved configuration versions of the app, newest first: version metadata only (id, version, time, operation, actor). Read one version for its before and after snapshots.
readAlso at /app/versions?app_name=... for app names that contain / or %.
Path, query & header parameters 3
app_name (path)stringrequiredExact app name, URL-encoded.
limit (query)integeroptionalPage size.
cursor (query)stringoptionalOpaque cursor from the previous page's next_cursor.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/versions?limit=50' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/versions/{version_id}Read a configuration version
One configuration version with before and after snapshots (secret values omitted).
readAlso at /app/versions/{version_id}?app_name=... for app names that contain / or %.
Path, query & header parameters 2
app_name (path)stringrequiredExact app name, URL-encoded.
version_id (path)stringrequiredNo request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/versions/ver_01' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/versions/{version_id}/rollbackRoll back app configuration
Restores the app settings saved in a version. Provider credentials and QuilrQL policy are not rolled back. Requires the current app ETag and an Idempotency-Key.
config:writeAlso at /app/versions/{version_id}/rollback?app_name=... for app names that contain / or %.
Path, query & header parameters 4
app_name (path)stringrequiredExact app name, URL-encoded.
version_id (path)stringrequiredIf-Match (header)stringrequiredQuoted version from the latest read of the resource. Prompt, attachment, conversion and rollback writes use the app version.
Idempotency-Key (header)stringrequiredUnique per logical write. A retry with the same key and body replays the original result for 24 hours; the same key with a different body is a 409.
Full request body specification application/json
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/versions/ver_01/rollback' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"' \
--header 'Idempotency-Key: create-support-bot-001'
Authentication, errors & retry rules Try it in the playground
/auditList audit events
Management events of the tenant, newest first: actor, operation, resource, result and time. Rejected writes are recorded with their error code. Events are kept for 90 days. New events never invalidate a cursor.
readPath, query & header parameters 7
limit (query)integeroptionalPage size.
cursor (query)stringoptionalOpaque cursor from the previous page's next_cursor.
actor (query)stringoptionalExact actor (a management key id or administrator).
operation (query)stringoptionalExact operation, for example provider_update.
resource (query)stringoptionalExact resource name or id as recorded.
since (query)stringoptionalInclusive start: RFC 3339 time, date (UTC midnight) or epoch seconds.
until (query)stringoptionalExclusive end: RFC 3339 time, date (UTC midnight) or epoch seconds.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/audit?limit=50' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/operations/{operation_id}Read operation status
State of an idempotent write started by the same management key (other keys get 404). An operation left pending by an interruption can be finished with recover.
readPath, query & header parameters 1
operation_id (path)stringrequiredNo request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/operations/5b1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/operations/{operation_id}/recoverRecover a pending operation
Finishes an interrupted app write (a 503 operation_pending response names its operation_id). Only the key that started it can recover it. Interrupted creations are not recovered here: retry the original POST with the same Idempotency-Key (409 retry_original_request).
config:writePath, query & header parameters 1
operation_id (path)stringrequiredFull request body specification application/json
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/operations/5b1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f/recover' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground