Apps and credentials API
An app owns its gateway credentials, stored controls, routing, prompts and configuration history. Manage it by app name within the key's tenant. App deletion is Not Generally Available.
Apps and provider attachments
Naming and identity
Names are trimmed and compared case-insensitively. New names must be unique among enabled and disabled apps. A disabled app continues to reserve its name. If multiple legacy apps match a name, the API returns 409 ambiguous_app_name instead of choosing one silently.
For simple names, encode one URL path segment: Support Bot becomes Support%20Bot. For names containing /, % or other proxy-sensitive characters, use /app?app_name=<URL-encoded name>. Every app subresource has this query alias, for example /app/keys?app_name=Team%20%2F%20Support. Encode the query value once. The endpoint reference below shows the path form of each operation; its alias takes the same inputs and is noted under the operation. App renaming is Not Generally Available. Changing an individual credential does not change the canonical app or log attribution.
Creating an app
App creation validates configuration without contacting an upstream model. When QuilrQL is already enabled, creation captures an app baseline and can publish an app-scoped allowed-models default for all users. This does not enable authority or edit drafts, and matching tenant policies still apply. See QuilrQL behavior. Model reachability requires an explicit supported model test.
Disable means the whole app
PATCH enabled:false to prevent newly admitted runtime traffic once the new configuration has propagated. Settings, provider references, keys, prompts and history remain available to management. Setting enabled:true resumes normal authentication, provider and policy checks.
Whole-app availability is independent of QuilrQL. Disabling an app does not become an inactive policy-governed setting, and re-enabling it does not resurrect expired/revoked keys. This is different from disabling just its primary provider.
Attachment and conversion rules
- Attach an existing enabled shared provider by label.
primary:falsepreserves the current primary;primary:truedeliberately promotes the attachment. provider_labelson an app PATCH replaces the entire ordered selection. Omission preserves it.- A detach is app-local and validates remaining routing references and provider selection. While QuilrQL is enabled, provider removal conservatively returns
409 policy_dependency; adding a provider remains supported. Provider-backed apps must keep at least one provider. - Legacy inline-provider apps can be read and receive non-provider edits. Provider changes require the explicit conversion endpoint first.
- Conversion supplies the complete shared-provider selection and optional routing, using the current app ETag. It preserves the app and its keys. It does not create shared providers or publish policy, and it has no idempotent-replay contract.
App endpoints
Expand Full request body specification for every field, including nested configuration. For a focused view, see the configuration schema.
/appsList apps
Apps of the tenant with their stored settings. Filters: `name` (case-insensitive substring), `tag` (exact), `enabled` (true or false), `origin` (`blueprint`: apps people created from a blueprint in self-service; `admin`: every other app) and `created_by` (the email of the person who created the app from a blueprint).
readPath, query & header parameters 7
limit (query)integeroptionalPage size.
cursor (query)stringoptionalOpaque cursor from the previous page's next_cursor.
name (query)stringoptionalCase-insensitive substring of the app name.
tag (query)stringoptionalExact tag.
enabled (query)booleanoptionalorigin (query)stringoptionalblueprint: apps people created from a blueprint in self-service (they carry `origin`); admin: every other app.
"blueprint""admin"created_by (query)stringoptionalOnly apps this person created from a blueprint (email, case-insensitive).
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps?limit=50' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/appsCreate an app
Creates an app and issues its first gateway key (returned once in `key.secret`). Requires both config:write and credentials:write. When QuilrQL governs the tenant, the app's configured models are allowed for all its users by default and a `quilrql_governs_app` warning is returned. If that default policy would exceed the tenant's QuilrQL capacity (1,000 policies), creation is refused with 422 policy_capacity_exceeded (`limits`, `exceeded`) before anything is written. Retrying with the same Idempotency-Key returns the same app and key.
config:writecredentials: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
accessobjectoptionalObject 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.
enabledbooleanoptionalinitial_keyobjectoptionalObject fields
expires_atstring | nulloptionalFuture RFC 3339 time with a timezone; null never expires.
namestringoptionalUnknown fields are rejected in this object.
limitsobjectoptionalObject 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.
modestringoptional"gateway""sdk""copilot_studio"namestringrequiredpromptsobjectoptionalObject 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.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps' \
--header 'Authorization: Bearer <management-key>' \
--header 'Idempotency-Key: create-support-bot-001' \
--header 'Content-Type: application/json' \
--data '{
"initial_key": {
"expires_at": "2027-01-01T00:00:00Z",
"name": "Backend"
},
"limits": {
"rate_limit_per_minute": 600,
"timeout": 30
},
"mode": "sdk",
"name": "Claims SDK"
}'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}Read an app
Stored settings of one app, grouped by section, with secret values omitted. `version` is the app ETag used by every app write, including prompts, attachments and rollback.
readAlso at /app?app_name=... for app names that contain / or %.
Path, query & header parameters 1
app_name (path)stringrequiredExact app name, URL-encoded.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}Update or disable an app
Partial update: only the fields you send change, and fields inside a section merge. Set `enabled` to false to disable the app (its keys stop working until it is re-enabled). Send the quoted version from the latest read in If-Match. Settings governed by an active QuilrQL policy are saved but reported in an `inactive_under_quilrql` warning; routing members that cannot serve every client API produce non-blocking warnings.
config:writeAlso at /app?app_name=... for app names that contain / or %.
Path, query & header parameters 2
app_name (path)stringrequiredExact app name, 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
accessobjectoptionalObject 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.
curl --request PATCH \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"' \
--header 'Content-Type: application/json' \
--data '{
"detection": {
"data_risk_action": "redact"
},
"limits": {
"timeout": 30
}
}'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/provider-conversionConvert inline providers
Moves an inline app (legacy per-app credentials) to shared providers in one step: send the complete list of shared-provider labels and, optionally, routing rewritten to reference them. Uses the app ETag; 409 already_converted when the app already uses shared providers.
config:writeAlso at /app/provider-conversion?app_name=... for app names that contain / or %.
Path, query & header parameters 2
app_name (path)stringrequiredExact app name, 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
provider_labelsarray<string>requiredArray 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.
Unknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/provider-conversion' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"' \
--header 'Content-Type: application/json' \
--data '{
"provider_labels": [
"Production OpenAI"
]
}'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/providersList app providers
Ordered shared-provider labels attached to the app (the first is primary) and the app version. Not paginated.
readAlso at /app/providers?app_name=... for app names that contain / or %.
Path, query & header parameters 1
app_name (path)stringrequiredExact app name, URL-encoded.
No request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/providers' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/providers/{label}Detach an app provider
Removes the provider from the app after checking the remaining routes still resolve. Uses the app ETag. While QuilrQL governs the tenant, removal is refused (409 policy_dependency, with the rules as references) only when an active rule that can apply to the app names the provider; edit those rules first (GET /controls/references?provider_label=).
config:writeAlso at /app/providers/{label}?app_name=... for app names that contain / or %.
Path, query & header parameters 3
app_name (path)stringrequiredExact app name, URL-encoded.
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/apps/Support%20Bot/providers/Production%20OpenAI' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/providers/{label}Attach a shared provider
Adds the shared provider to the app; other attachments are kept. `primary: true` moves it first. Uses the app ETag. Inline apps must be converted first (409 provider_migration_required).
config:writeAlso at /app/providers/{label}?app_name=... for app names that contain / or %.
Path, query & header parameters 3
app_name (path)stringrequiredExact app name, URL-encoded.
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
primarybooleanoptionalMove the provider first (primary).
Unknown fields are rejected in this object.
curl --request PUT \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/providers/Production%20OpenAI' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"' \
--header 'Content-Type: application/json' \
--data '{
"primary": false
}'
Authentication, errors & retry rules Try it in the playground
Gateway app credentials
An app can have multiple named gateway credentials. They share the same app controls, limits, prompts and log identity. Issuing or revoking a credential does not create another app.
Credential contract
Whole-app disable overrides every credential without revoking it. On re-enable, only credentials still valid under expiry/revocation checks work again. JWT/self-service identity follows its own runtime authentication rules.
Rotate without changing the app
A dedicated rotation operation is Not Generally Available; the issue/migrate/revoke workflow above is supported. Retain the new credential in your secret store. credentials:write lets an issuer receive a newly created key, but it does not grant permission to reveal every existing key. Management-key issuance and retrieval follow a different administration contract.
GET an individual key to obtain its metadata and version; use that quoted version for PATCH/DELETE. Revocation returns 200 with the updated key and version. Request expires_at and returned gateway-key expiry use RFC 3339; null means no expiry.
Credential endpoints
/apps/{app_name}/keysList gateway credentials
Gateway keys of the app: metadata, a short fingerprint and recent usage, never the secret.
readAlso at /app/keys?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/keys?limit=50' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/keysIssue a gateway credential
Issues another gateway key for the app; the secret is returned once (and on an idempotent replay). Names are unique among the app's active and expired keys.
credentials:writeAlso at /app/keys?app_name=... for app names that contain / or %.
Path, query & header parameters 2
app_name (path)stringrequiredExact app name, 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
expires_atstring | nulloptionalFuture RFC 3339 time with a timezone; null never expires.
namestringrequiredUnknown fields are rejected in this object.
curl --request POST \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/keys' \
--header 'Authorization: Bearer <management-key>' \
--header 'Idempotency-Key: create-support-bot-001' \
--header 'Content-Type: application/json' \
--data '{
"expires_at": "2027-01-01T00:00:00Z",
"name": "Deployment"
}'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/keys/{key_id}Revoke a gateway credential
Revokes the key immediately and permanently. Revoking an already revoked key returns it unchanged. Send the quoted version from the latest read in If-Match.
credentials:writeAlso at /app/keys/{key_id}?app_name=... for app names that contain / or %.
Path, query & header parameters 3
app_name (path)stringrequiredExact app name, URL-encoded.
key_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
Unknown fields are rejected in this object.
curl --request DELETE \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/keys/6b0e2c1a-4f3d-4c55-9a1e-0d2b7f8c9e10' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/keys/{key_id}Read a gateway credential
Metadata and recent usage of one gateway key, and its version (ETag).
readAlso at /app/keys/{key_id}?app_name=... for app names that contain / or %.
Path, query & header parameters 2
app_name (path)stringrequiredExact app name, URL-encoded.
key_id (path)stringrequiredNo request body.
curl --request GET \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/keys/6b0e2c1a-4f3d-4c55-9a1e-0d2b7f8c9e10' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/keys/{key_id}Rename a gateway key or change its expiry
Renames a key (`name`, unique among active and expired keys: 409 duplicate_key_name) and/or sets or clears (null) the expiry of an active key. Revoked keys cannot change; expired keys can only be renamed (409 terminal_key_state). Send the quoted version from the latest read in If-Match.
credentials:writeAlso at /app/keys/{key_id}?app_name=... for app names that contain / or %.
Path, query & header parameters 3
app_name (path)stringrequiredExact app name, URL-encoded.
key_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
expires_atstring | nulloptionalFuture RFC 3339 time with a timezone; null never expires.
namestringoptionalUnknown fields are rejected in this object.
curl --request PATCH \
'https://guardrails-usa-1.quilr.ai/llmgateway/management/v1/apps/Support%20Bot/keys/6b0e2c1a-4f3d-4c55-9a1e-0d2b7f8c9e10' \
--header 'Authorization: Bearer <management-key>' \
--header 'If-Match: "3f1c0a9e5b7d"' \
--header 'Content-Type: application/json' \
--data '{
"expires_at": null
}'
Authentication, errors & retry rules Try it in the playground
/apps/{app_name}/keys/{key_id}/revealReveal a gateway credential
Returns the secret of an active key. Expired or revoked keys return 409 terminal_key_state. Every reveal is recorded in the audit trail.
credentials:readAlso at /app/keys/{key_id}/reveal?app_name=... for app names that contain / or %.
Path, query & header parameters 2
app_name (path)stringrequiredExact app name, URL-encoded.
key_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/apps/Support%20Bot/keys/6b0e2c1a-4f3d-4c55-9a1e-0d2b7f8c9e10/reveal' \
--header 'Authorization: Bearer <management-key>'
Authentication, errors & retry rules Try it in the playground
Personal (self-service) API keys are on the Self-service API page.