Skip to main content

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​

InputRule
nameRequired display name, 1-200 characters.
modegateway by default; sdk and copilot_studio preserve their existing providerless app modes.
provider_labelsRequired, ordered, nonempty list for gateway apps. First is primary. Omit for providerless modes.
initial_keyOptional. Omission still issues one key named Default. Optional expiry applies to the gateway key, not the management key.
Configuration sectionsSee full configuration input. Omitted controls use existing gateway defaults. Capabilities lists supported fields and modes; it does not return every effective runtime default.

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:false preserves the current primary; primary:true deliberately promotes the attachment.
  • provider_labels on 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.

GET/apps

List 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).

REQUIRESread
Path, query & header parameters 7
limit (query)integeroptional

Page size.

min: 1max: 200default: 50
cursor (query)stringoptional

Opaque cursor from the previous page's next_cursor.

name (query)stringoptional

Case-insensitive substring of the app name.

tag (query)stringoptional

Exact tag.

enabled (query)booleanoptional
origin (query)stringoptional

blueprint: apps people created from a blueprint in self-service (they carry `origin`); admin: every other app.

"blueprint""admin"
created_by (query)stringoptional

Only 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

POST/apps

Create 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.

REQUIRESconfig:writecredentials:write
Path, query & header parameters 1
Idempotency-Key (header)stringrequired

Unique 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.

min length: 1max length: 200
Full request body specification application/json

accessobjectoptional
Object fields
allowed_source_ipsone of 3 variantsoptional
Variant 1 array<string>
array<string>
Variant 2 object
enabledbooleanoptional
ipsarray<string>optional
Array item specification
string

Unknown fields are rejected in this object.

Also accepts null.

allowed_user_domainsarray<string>optional
max items: 1000
Array item specification
string
allowed_user_emailsarray<string>optional
max items: 1000
Array item specification
string
enforce_conversation_idbooleanoptional
enforce_identitybooleanoptional
identity_header_modebooleanoptional
identity_token_headersarray<string>optional
max items: 1000
Array item specification
string
identity_token_oid_fallbackbooleanoptional
jwt_authobject | nulloptional
JwtAuth object
allowed_audiencesarray | nulloptional

Omitted or null keeps the stored list.

allowed_client_idsarray<string>optional
Array item specification
string
allowed_issuersarray<string>optional
Array item specification
string
email_claimstring | nulloptional

Claim read first for the user's email.

enabledbooleanoptional
kidstringoptional
default: "default"
public_key_pemstringoptional

RSA public key (PEM). Required when enabling; this API does not fetch JWKS URLs.

subject_fallbackboolean | nulloptional

Use the token subject as identity when it has no email.

verify_audienceboolean | nulloptional

Requires 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 | nulloptional
Alerting object
app_levelobjectoptional
Object fields
cooldown_minutesintegeroptional
min: 1default: 10
enabledbooleanoptional
default: false
failure_rate_thresholdnumberoptional

Percentage.

min: 0max: 100default: 10
minimum_requestsintegeroptional
min: 0default: 20
notify_on_recoverybooleanoptional
default: true
window_minutesintegeroptional
min: 5max: 1440default: 15
channelsobjectoptional
Object fields
emailsarray<string>optional
unique items
Array item specification
string
format: email
webhooksarray<object>optional
Array item specification
idstringoptional
min length: 1
labelstringoptional
typestringoptional
default: "generic"
"slack""generic"
urlstringrequired

HTTPS webhook URL, required for every submitted webhook.

format: uriwrite only
provider_levelobjectoptional
Object fields
cooldown_minutesintegeroptional
min: 1default: 10
enabledbooleanoptional
default: false
failure_rate_thresholdnumberoptional

Percentage.

min: 0max: 100default: 10
minimum_requestsintegeroptional
min: 0default: 20
notify_on_recoverybooleanoptional
default: true
window_minutesintegeroptional
min: 5max: 1440default: 15

Also accepts null.

detectionobjectoptional
Object fields
attachment_scanningobjectoptional

Request 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
enabledbooleanoptional
default: false
image_classificationbooleanoptional
default: true
max_file_bytesintegeroptional
min: 1max: 536870912default: 20971520
max_filesintegeroptional
min: 1max: 1000default: 20
max_request_bytesintegeroptional
min: 1max: 2147483648default: 52428800
ocrobjectoptional
default: "no_text_layer"
"off""no_text_layer""always"
ocr_scriptsarray<object>optional
default: []
Array item specification
object

Values: "latin""cjk""korean""cyrillic""arabic""devanagari""tamil""telugu""thai""greek"

on_limit_violationobjectoptional
default: "block"
"monitor""strip""block"
on_macrosobjectoptional
default: "monitor"
"monitor""strip""block"
on_unscannableobjectoptional

What 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.

default: "monitor"
"monitor""strip""block"
pdf_max_pagesintegeroptional
min: 1max: 10000default: 200
redact_documents_as_textbooleanoptional
default: false
text_extractionbooleanoptional
default: true
type_actionsobjectoptional

Per detected kind: allow, strip or block. Kinds not listed are allowed; updates merge per kind and {} resets every kind to allow.

default: {}
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>optional

Category ID to action.

Map value specification
string

Adversarial detections have no redactable spans; actions they cannot apply are rejected.

Values: "monitor""partial-redact""tokenize""redact""block"

category_scopesmap<string, string>optional
Map value specification
string

Values: "request""response""both"

category_sensitivitiesmap<string, array<string>>optional
Map value specification
array<string>
custom_definitionsarray<object>optional

Replaces the whole selection; [] clears it. Never deletes definitions.

max items: 1000
Array item specification
actionstringoptional

Adversarial detections have no redactable spans; actions they cannot apply are rejected.

"monitor""partial-redact""tokenize""redact""block"
definition_idstringrequired

Stable ID from GET /custom-definitions.

min length: 1max length: 200
enabledbooleanoptional
default: true
scopestringoptional
"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>optional
Map value specification
string

Values: "low""medium""high"

enabled_categoriesmap<string, boolean>optional

Catalog category or subcategory IDs mapped to enabled state. Unknown IDs are rejected.

Map value specification
boolean
guardian_agentobjectoptional

Partial 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_helpersobjectoptional
Object fields
dependency_security_checkbooleanoptional
enabledbooleanoptional
latest_version_suggestionsbooleanoptional
enabledbooleanoptional
task_adherenceobjectoptional
Object fields
actionstringoptional
"nudge""block"
agent_purposestringoptional
enabledbooleanoptional
guardian_agent_promptstringoptional
sensitivitystringoptional
"low""medium""high"
hallucination_check_actionstringoptional
"block""monitor"
hallucination_check_risk_levelstringoptional
hallucination_check_score_thresholdnumberoptional
min: 0max: 1
is_hallucination_check_enabledbooleanoptional
sub_category_actionsmap<string, map<string, string>>optional

Category ID to subcategory name to action.

Map value specification
map<string, string>
sub_category_sensitivitiesmap<string, map<string, string>>optional
Map value specification
map<string, string>

Unknown fields are rejected in this object.

enabledbooleanoptional
initial_keyobjectoptional
Object fields
expires_atstring | nulloptional

Future RFC 3339 time with a timezone; null never expires.

format: date-time
namestringoptional
min length: 1max length: 120

Unknown fields are rejected in this object.

limitsobjectoptional
Object fields
concurrency_per_minuteinteger | nulloptional
min: 0
model_rate_limitsarray<object>optional
Array item specification
concurrency_per_minuteinteger | nulloptional

Request admissions per 60 seconds.

min: 0
modelstringrequired

Exact configured model identifier.

min length: 1max length: 512
provider_labelstringrequired

Exact shared-provider label.

min length: 1max length: 200
rate_limitobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

timeoutnumber | nulloptional

Seconds.

min: 0
token_limitsobject | nulloptional
TokenLimits object
inputobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

max_per_requestinteger | nulloptional

Maximum input tokens per request; 0 disables.

min: 0
outputobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

Also accepts null.

rate_limitobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

rate_limit_per_minuteintegeroptional
min: 0
timeoutinteger | nulloptional
min: 0
token_limitsobjectoptional
Object fields
inputobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

max_per_requestinteger | nulloptional

Maximum input tokens per request; 0 disables.

min: 0
outputobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

Unknown fields are rejected in this object.

modestringoptional
default: "gateway"
"gateway""sdk""copilot_studio"
namestringrequired
min length: 1max length: 200
promptsobjectoptional
Object fields
require_system_from_storebooleanoptional
universal_system_promptobjectoptional

Prepended to the system prompt of every request when enabled; partial objects merge onto the stored value.

Object fields
contentstringoptional
max length: 100000
enabledbooleanoptional

Unknown fields are rejected in this object.

Unknown fields are rejected in this object.

provider_labelsarray<string>optional
max items: 1000
Array item specification
string
routingobjectoptional
Object fields
custom_routingarray<object>optional
Array item specification
groupstringoptional
default: "chat_completion"
"anthropic_messages""bedrock_runtime""chat_completion""responses""vertex_ai"
is_publishedbooleanrequired
modelsarray<object>required
Array item specification
credential_sourcestringoptional
labelstringoptional
modelstringrequired
provider_namestringrequired
typestringrequired
"High_Context_Request""Low_Context_Request""Medium_Context_Request"
routing_groupsarray<object>optional
Array item specification
group_kindstringoptional

Client API family the group serves.

"chat_completion""anthropic_messages""vertex_ai""responses""realtime""bedrock_runtime"
group_namestringrequired
modelsarray<object>required
min items: 1
Array item specification
credential_sourcestringoptional

Label of a shared provider attached to the app; inline credentials are not accepted.

model_namestringrequired
provider_namestringrequired
weightnumberrequired
greater than: 0
routing_thresholdsobjectoptional

Word-count boundaries of context routes: 0 <= low_max_words <= medium_max_words.

Object fields
low_max_wordsintegerrequired
min: 0
medium_max_wordsintegerrequired
min: 0

Unknown fields are rejected in this object.

token_based_routing_groupsarray<object>optional
Array item specification
group_kindstringoptional

Client API family the group serves.

"chat_completion""anthropic_messages""vertex_ai""responses""realtime""bedrock_runtime"
group_namestringrequired
modelsarray<object>required
min items: 1
Array item specification
credential_sourcestringoptional

Label of a shared provider attached to the app; inline credentials are not accepted.

model_namestringrequired
provider_namestringrequired
weightnumberrequired
greater than: 0

Unknown fields are rejected in this object.

self_serviceobjectoptional
Object fields
enable_self_servicebooleanoptional
self_serviceobjectoptional

Self-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 | nulloptional
Variant 1 object
self_service_viewerobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
settings_update_directobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
settings_update_requesterobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
show_api_keyobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
show_logs_for_all_usersobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
version1optional

Also accepts null.

max_api_key_ttl_daysinteger | nulloptional

Longest 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.

min: 1max: 3650
originobjectoptional

Present 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_appstringoptional

The app it was copied from.

blueprint_config_versioninteger | nulloptional

The blueprint's configuration version at the copy.

created_atstring | nulloptional
created_bystringoptional

Email of the person who created it.

kindstringoptional
"blueprint"
ownersarray<string>optional

Emails 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 [].

max items: 20
Array item specification
string

Unknown fields are rejected in this object.

smart_group_policiesarray<object>optional
Array item specification
actionsobjectoptional
Object fields
data_risk_actionstringoptional

Adversarial 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>optional
Map value specification
string

Adversarial detections have no redactable spans; actions they cannot apply are rejected.

Values: "monitor""partial-redact""tokenize""redact""block"

category_scopesmap<string, string>optional
Map value specification
string

Values: "request""response""both"

category_sensitivitiesmap<string, array<string>>optional
Map value specification
array<string>
enabledbooleanoptional
enabled_categoriesmap<string, boolean>optional

Catalog category or subcategory IDs to enabled state.

Map value specification
boolean
group_namestringrequired
sub_category_actionsmap<string, map<string, string>>optional
Map value specification
map<string, string>
sub_category_sensitivitiesmap<string, map<string, string>>optional
Map value specification
map<string, string>

Unknown fields are rejected in this object.

tagsarray<string>optional
max items: 1000
Array item specification
string
transformationsobjectoptional
Object fields
response_cacheobjectoptional

Response cache for non-streaming requests. Partial updates merge. Under QuilrQL the policy decides enabled, match and similarity.

Object fields
enabledbooleanoptional
default: false
flushbooleanoptional

true discards every cached response of the app.

write only
matchobjectoptional

exact: 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.

default: "exact"
"exact""normalized""semantic"
max_size_mbintegeroptional
min: 1max: 1024default: 32
scopeobjectoptional
default: "app"
"app""user"
similarityobjectoptional

How close a semantic match must be. Used only when match is semantic.

default: "narrow"
"narrow""balanced""wider"
ttl_secondsintegeroptional
min: 60max: 604800default: 86400

Unknown fields are rejected in this object.

token_savingobjectoptional

Request-body transforms that reduce input tokens.

Object fields
base64_blob_elisionbooleanoptional
html_to_textbooleanoptional
json_minificationbooleanoptional
markdown_to_textbooleanoptional
smart_json_compressionbooleanoptional
text_compressionbooleanoptional
tool_output_cleanupbooleanoptional

Unknown 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

GET/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.

REQUIRESread

Also at /app?app_name=... for app names that contain / or %.

Path, query & header parameters 1
app_name (path)stringrequired

Exact 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

PATCH/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.

REQUIRESconfig:write

Also at /app?app_name=... for app names that contain / or %.

Path, query & header parameters 2
app_name (path)stringrequired

Exact app name, URL-encoded.

If-Match (header)stringrequired

Quoted version from the latest read of the resource. Prompt, attachment, conversion and rollback writes use the app version.

Full request body specification application/json

accessobjectoptional
Object fields
allowed_source_ipsone of 3 variantsoptional
Variant 1 array<string>
array<string>
Variant 2 object
enabledbooleanoptional
ipsarray<string>optional
Array item specification
string

Unknown fields are rejected in this object.

Also accepts null.

allowed_user_domainsarray<string>optional
max items: 1000
Array item specification
string
allowed_user_emailsarray<string>optional
max items: 1000
Array item specification
string
enforce_conversation_idbooleanoptional
enforce_identitybooleanoptional
identity_header_modebooleanoptional
identity_token_headersarray<string>optional
max items: 1000
Array item specification
string
identity_token_oid_fallbackbooleanoptional
jwt_authobject | nulloptional
JwtAuth object
allowed_audiencesarray | nulloptional

Omitted or null keeps the stored list.

allowed_client_idsarray<string>optional
Array item specification
string
allowed_issuersarray<string>optional
Array item specification
string
email_claimstring | nulloptional

Claim read first for the user's email.

enabledbooleanoptional
kidstringoptional
default: "default"
public_key_pemstringoptional

RSA public key (PEM). Required when enabling; this API does not fetch JWKS URLs.

subject_fallbackboolean | nulloptional

Use the token subject as identity when it has no email.

verify_audienceboolean | nulloptional

Requires 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 | nulloptional
Alerting object
app_levelobjectoptional
Object fields
cooldown_minutesintegeroptional
min: 1default: 10
enabledbooleanoptional
default: false
failure_rate_thresholdnumberoptional

Percentage.

min: 0max: 100default: 10
minimum_requestsintegeroptional
min: 0default: 20
notify_on_recoverybooleanoptional
default: true
window_minutesintegeroptional
min: 5max: 1440default: 15
channelsobjectoptional
Object fields
emailsarray<string>optional
unique items
Array item specification
string
format: email
webhooksarray<object>optional
Array item specification
idstringoptional
min length: 1
labelstringoptional
typestringoptional
default: "generic"
"slack""generic"
urlstringrequired

HTTPS webhook URL, required for every submitted webhook.

format: uriwrite only
provider_levelobjectoptional
Object fields
cooldown_minutesintegeroptional
min: 1default: 10
enabledbooleanoptional
default: false
failure_rate_thresholdnumberoptional

Percentage.

min: 0max: 100default: 10
minimum_requestsintegeroptional
min: 0default: 20
notify_on_recoverybooleanoptional
default: true
window_minutesintegeroptional
min: 5max: 1440default: 15

Also accepts null.

detectionobjectoptional
Object fields
attachment_scanningobjectoptional

Request 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
enabledbooleanoptional
default: false
image_classificationbooleanoptional
default: true
max_file_bytesintegeroptional
min: 1max: 536870912default: 20971520
max_filesintegeroptional
min: 1max: 1000default: 20
max_request_bytesintegeroptional
min: 1max: 2147483648default: 52428800
ocrobjectoptional
default: "no_text_layer"
"off""no_text_layer""always"
ocr_scriptsarray<object>optional
default: []
Array item specification
object

Values: "latin""cjk""korean""cyrillic""arabic""devanagari""tamil""telugu""thai""greek"

on_limit_violationobjectoptional
default: "block"
"monitor""strip""block"
on_macrosobjectoptional
default: "monitor"
"monitor""strip""block"
on_unscannableobjectoptional

What 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.

default: "monitor"
"monitor""strip""block"
pdf_max_pagesintegeroptional
min: 1max: 10000default: 200
redact_documents_as_textbooleanoptional
default: false
text_extractionbooleanoptional
default: true
type_actionsobjectoptional

Per detected kind: allow, strip or block. Kinds not listed are allowed; updates merge per kind and {} resets every kind to allow.

default: {}
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>optional

Category ID to action.

Map value specification
string

Adversarial detections have no redactable spans; actions they cannot apply are rejected.

Values: "monitor""partial-redact""tokenize""redact""block"

category_scopesmap<string, string>optional
Map value specification
string

Values: "request""response""both"

category_sensitivitiesmap<string, array<string>>optional
Map value specification
array<string>
custom_definitionsarray<object>optional

Replaces the whole selection; [] clears it. Never deletes definitions.

max items: 1000
Array item specification
actionstringoptional

Adversarial detections have no redactable spans; actions they cannot apply are rejected.

"monitor""partial-redact""tokenize""redact""block"
definition_idstringrequired

Stable ID from GET /custom-definitions.

min length: 1max length: 200
enabledbooleanoptional
default: true
scopestringoptional
"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>optional
Map value specification
string

Values: "low""medium""high"

enabled_categoriesmap<string, boolean>optional

Catalog category or subcategory IDs mapped to enabled state. Unknown IDs are rejected.

Map value specification
boolean
guardian_agentobjectoptional

Partial 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_helpersobjectoptional
Object fields
dependency_security_checkbooleanoptional
enabledbooleanoptional
latest_version_suggestionsbooleanoptional
enabledbooleanoptional
task_adherenceobjectoptional
Object fields
actionstringoptional
"nudge""block"
agent_purposestringoptional
enabledbooleanoptional
guardian_agent_promptstringoptional
sensitivitystringoptional
"low""medium""high"
hallucination_check_actionstringoptional
"block""monitor"
hallucination_check_risk_levelstringoptional
hallucination_check_score_thresholdnumberoptional
min: 0max: 1
is_hallucination_check_enabledbooleanoptional
sub_category_actionsmap<string, map<string, string>>optional

Category ID to subcategory name to action.

Map value specification
map<string, string>
sub_category_sensitivitiesmap<string, map<string, string>>optional
Map value specification
map<string, string>

Unknown fields are rejected in this object.

enabledbooleanoptional
limitsobjectoptional
Object fields
concurrency_per_minuteinteger | nulloptional
min: 0
model_rate_limitsarray<object>optional
Array item specification
concurrency_per_minuteinteger | nulloptional

Request admissions per 60 seconds.

min: 0
modelstringrequired

Exact configured model identifier.

min length: 1max length: 512
provider_labelstringrequired

Exact shared-provider label.

min length: 1max length: 200
rate_limitobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

timeoutnumber | nulloptional

Seconds.

min: 0
token_limitsobject | nulloptional
TokenLimits object
inputobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

max_per_requestinteger | nulloptional

Maximum input tokens per request; 0 disables.

min: 0
outputobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

Also accepts null.

rate_limitobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

rate_limit_per_minuteintegeroptional
min: 0
timeoutinteger | nulloptional
min: 0
token_limitsobjectoptional
Object fields
inputobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

max_per_requestinteger | nulloptional

Maximum input tokens per request; 0 disables.

min: 0
outputobject | nulloptional
RateLimit object
durationstringrequired
"minute""hour""day"
valueintegerrequired

Maximum events in the window; 0 disables.

min: 0

Also accepts null.

Unknown fields are rejected in this object.

promptsobjectoptional
Object fields
require_system_from_storebooleanoptional
universal_system_promptobjectoptional

Prepended to the system prompt of every request when enabled; partial objects merge onto the stored value.

Object fields
contentstringoptional
max length: 100000
enabledbooleanoptional

Unknown fields are rejected in this object.

Unknown fields are rejected in this object.

provider_labelsarray<string>optional
max items: 1000
Array item specification
string
routingobjectoptional
Object fields
custom_routingarray<object>optional
Array item specification
groupstringoptional
default: "chat_completion"
"anthropic_messages""bedrock_runtime""chat_completion""responses""vertex_ai"
is_publishedbooleanrequired
modelsarray<object>required
Array item specification
credential_sourcestringoptional
labelstringoptional
modelstringrequired
provider_namestringrequired
typestringrequired
"High_Context_Request""Low_Context_Request""Medium_Context_Request"
routing_groupsarray<object>optional
Array item specification
group_kindstringoptional

Client API family the group serves.

"chat_completion""anthropic_messages""vertex_ai""responses""realtime""bedrock_runtime"
group_namestringrequired
modelsarray<object>required
min items: 1
Array item specification
credential_sourcestringoptional

Label of a shared provider attached to the app; inline credentials are not accepted.

model_namestringrequired
provider_namestringrequired
weightnumberrequired
greater than: 0
routing_thresholdsobjectoptional

Word-count boundaries of context routes: 0 <= low_max_words <= medium_max_words.

Object fields
low_max_wordsintegerrequired
min: 0
medium_max_wordsintegerrequired
min: 0

Unknown fields are rejected in this object.

token_based_routing_groupsarray<object>optional
Array item specification
group_kindstringoptional

Client API family the group serves.

"chat_completion""anthropic_messages""vertex_ai""responses""realtime""bedrock_runtime"
group_namestringrequired
modelsarray<object>required
min items: 1
Array item specification
credential_sourcestringoptional

Label of a shared provider attached to the app; inline credentials are not accepted.

model_namestringrequired
provider_namestringrequired
weightnumberrequired
greater than: 0

Unknown fields are rejected in this object.

self_serviceobjectoptional
Object fields
enable_self_servicebooleanoptional
self_serviceobjectoptional

Self-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 | nulloptional
Variant 1 object
self_service_viewerobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
settings_update_directobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
settings_update_requesterobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
show_api_keyobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
show_logs_for_all_usersobjectoptional

Deny rules win. Referencing a group never changes its membership.

Object fields
allow_allbooleanoptional
default: false
allow_emailsarray<string>optional
unique items
Array item specification
string
format: email
allow_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
deny_emailsarray<string>optional
unique items
Array item specification
string
format: email
deny_smart_groupsarray<string>optional
unique items
Array item specification
string

Existing smart-group name.

min length: 1
version1optional

Also accepts null.

max_api_key_ttl_daysinteger | nulloptional

Longest 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.

min: 1max: 3650
originobjectoptional

Present 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_appstringoptional

The app it was copied from.

blueprint_config_versioninteger | nulloptional

The blueprint's configuration version at the copy.

created_atstring | nulloptional
created_bystringoptional

Email of the person who created it.

kindstringoptional
"blueprint"
ownersarray<string>optional

Emails 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 [].

max items: 20
Array item specification
string

Unknown fields are rejected in this object.

smart_group_policiesarray<object>optional
Array item specification
actionsobjectoptional
Object fields
data_risk_actionstringoptional

Adversarial 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>optional
Map value specification
string

Adversarial detections have no redactable spans; actions they cannot apply are rejected.

Values: "monitor""partial-redact""tokenize""redact""block"

category_scopesmap<string, string>optional
Map value specification
string

Values: "request""response""both"

category_sensitivitiesmap<string, array<string>>optional
Map value specification
array<string>
enabledbooleanoptional
enabled_categoriesmap<string, boolean>optional

Catalog category or subcategory IDs to enabled state.

Map value specification
boolean
group_namestringrequired
sub_category_actionsmap<string, map<string, string>>optional
Map value specification
map<string, string>
sub_category_sensitivitiesmap<string, map<string, string>>optional
Map value specification
map<string, string>

Unknown fields are rejected in this object.

tagsarray<string>optional
max items: 1000
Array item specification
string
transformationsobjectoptional
Object fields
response_cacheobjectoptional

Response cache for non-streaming requests. Partial updates merge. Under QuilrQL the policy decides enabled, match and similarity.

Object fields
enabledbooleanoptional
default: false
flushbooleanoptional

true discards every cached response of the app.

write only
matchobjectoptional

exact: 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.

default: "exact"
"exact""normalized""semantic"
max_size_mbintegeroptional
min: 1max: 1024default: 32
scopeobjectoptional
default: "app"
"app""user"
similarityobjectoptional

How close a semantic match must be. Used only when match is semantic.

default: "narrow"
"narrow""balanced""wider"
ttl_secondsintegeroptional
min: 60max: 604800default: 86400

Unknown fields are rejected in this object.

token_savingobjectoptional

Request-body transforms that reduce input tokens.

Object fields
base64_blob_elisionbooleanoptional
html_to_textbooleanoptional
json_minificationbooleanoptional
markdown_to_textbooleanoptional
smart_json_compressionbooleanoptional
text_compressionbooleanoptional
tool_output_cleanupbooleanoptional

Unknown 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

POST/apps/{app_name}/provider-conversion

Convert 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.

REQUIRESconfig:write

Also at /app/provider-conversion?app_name=... for app names that contain / or %.

Path, query & header parameters 2
app_name (path)stringrequired

Exact app name, URL-encoded.

If-Match (header)stringrequired

Quoted 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>required
max items: 1000
Array item specification
string
routingobjectoptional
Object fields
custom_routingarray<object>optional
Array item specification
groupstringoptional
default: "chat_completion"
"anthropic_messages""bedrock_runtime""chat_completion""responses""vertex_ai"
is_publishedbooleanrequired
modelsarray<object>required
Array item specification
credential_sourcestringoptional
labelstringoptional
modelstringrequired
provider_namestringrequired
typestringrequired
"High_Context_Request""Low_Context_Request""Medium_Context_Request"
routing_groupsarray<object>optional
Array item specification
group_kindstringoptional

Client API family the group serves.

"chat_completion""anthropic_messages""vertex_ai""responses""realtime""bedrock_runtime"
group_namestringrequired
modelsarray<object>required
min items: 1
Array item specification
credential_sourcestringoptional

Label of a shared provider attached to the app; inline credentials are not accepted.

model_namestringrequired
provider_namestringrequired
weightnumberrequired
greater than: 0
routing_thresholdsobjectoptional

Word-count boundaries of context routes: 0 <= low_max_words <= medium_max_words.

Object fields
low_max_wordsintegerrequired
min: 0
medium_max_wordsintegerrequired
min: 0

Unknown fields are rejected in this object.

token_based_routing_groupsarray<object>optional
Array item specification
group_kindstringoptional

Client API family the group serves.

"chat_completion""anthropic_messages""vertex_ai""responses""realtime""bedrock_runtime"
group_namestringrequired
modelsarray<object>required
min items: 1
Array item specification
credential_sourcestringoptional

Label of a shared provider attached to the app; inline credentials are not accepted.

model_namestringrequired
provider_namestringrequired
weightnumberrequired
greater than: 0

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/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

GET/apps/{app_name}/providers

List app providers

Ordered shared-provider labels attached to the app (the first is primary) and the app version. Not paginated.

REQUIRESread

Also at /app/providers?app_name=... for app names that contain / or %.

Path, query & header parameters 1
app_name (path)stringrequired

Exact 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

DELETE/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=).

REQUIRESconfig:write

Also at /app/providers/{label}?app_name=... for app names that contain / or %.

Path, query & header parameters 3
app_name (path)stringrequired

Exact app name, URL-encoded.

label (path)stringrequired

Shared-provider label, URL-encoded.

If-Match (header)stringrequired

Quoted 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

PUT/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).

REQUIRESconfig:write

Also at /app/providers/{label}?app_name=... for app names that contain / or %.

Path, query & header parameters 3
app_name (path)stringrequired

Exact app name, URL-encoded.

label (path)stringrequired

Shared-provider label, URL-encoded.

If-Match (header)stringrequired

Quoted version from the latest read of the resource. Prompt, attachment, conversion and rollback writes use the app version.

Full request body specification application/json

primarybooleanoptional

Move the provider first (primary).

default: false

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​

PropertyRule
Initial credentialApp creation always issues one, named Default unless overridden.
Additional credentialsRequire a display name and credentials:write.
NamesTrimmed, 1-120 characters, unique case-insensitively among non-revoked keys of the app.
ExpiryOptional RFC 3339 timestamp. Omitted/null creation expiry means no expiry.
Changing expiryActive credentials only; null clears expiry.
RenamingPATCH {name} (with or without expires_at), under the same name rules (409 duplicate_key_name). Expired keys can be renamed; revoked keys cannot change (409 terminal_key_state). Every field is validated before anything is written.
Key idsThe key issued with the app keeps its original id (it starts with legacy-); later keys get UUIDs. Usage and logs are tracked by this id, so it never changes.
RevocationPreserves history and releases the name. Other valid keys still work.
ListingMetadata/fingerprints only, plus usage: last_used_at (most recent request in the last 90 days, null when there was none) and requests_30d (0 when there were none). usage itself is null only when usage data is unavailable, and can be up to 60 seconds old. Use it to find stale keys.
RevealingExplicit credentials:read; response is not cacheable. Only active keys can be retrieved. Expired/revoked-key reveal is Not Generally Available and returns 409 terminal_key_state.

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​

Issue
Create a second named key
Migrate
Move callers to the new key
Revoke
Revoke the old credential
QuilrAI

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​

GET/apps/{app_name}/keys

List gateway credentials

Gateway keys of the app: metadata, a short fingerprint and recent usage, never the secret.

REQUIRESread

Also at /app/keys?app_name=... for app names that contain / or %.

Path, query & header parameters 3
app_name (path)stringrequired

Exact app name, URL-encoded.

limit (query)integeroptional

Page size.

min: 1max: 200default: 50
cursor (query)stringoptional

Opaque 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

POST/apps/{app_name}/keys

Issue 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.

REQUIREScredentials:write

Also at /app/keys?app_name=... for app names that contain / or %.

Path, query & header parameters 2
app_name (path)stringrequired

Exact app name, URL-encoded.

Idempotency-Key (header)stringrequired

Unique 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.

min length: 1max length: 200
Full request body specification application/json

expires_atstring | nulloptional

Future RFC 3339 time with a timezone; null never expires.

format: date-time
namestringrequired
min length: 1max length: 120

Unknown 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

DELETE/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.

REQUIREScredentials:write

Also at /app/keys/{key_id}?app_name=... for app names that contain / or %.

Path, query & header parameters 3
app_name (path)stringrequired

Exact app name, URL-encoded.

key_id (path)stringrequired
If-Match (header)stringrequired

Quoted 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

GET/apps/{app_name}/keys/{key_id}

Read a gateway credential

Metadata and recent usage of one gateway key, and its version (ETag).

REQUIRESread

Also at /app/keys/{key_id}?app_name=... for app names that contain / or %.

Path, query & header parameters 2
app_name (path)stringrequired

Exact app name, URL-encoded.

key_id (path)stringrequired

No 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

PATCH/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.

REQUIREScredentials:write

Also at /app/keys/{key_id}?app_name=... for app names that contain / or %.

Path, query & header parameters 3
app_name (path)stringrequired

Exact app name, URL-encoded.

key_id (path)stringrequired
If-Match (header)stringrequired

Quoted 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 | nulloptional

Future RFC 3339 time with a timezone; null never expires.

format: date-time
namestringoptional
min length: 1max length: 120

Unknown 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

POST/apps/{app_name}/keys/{key_id}/reveal

Reveal 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.

REQUIREScredentials:read

Also at /app/keys/{key_id}/reveal?app_name=... for app names that contain / or %.

Path, query & header parameters 2
app_name (path)stringrequired

Exact app name, URL-encoded.

key_id (path)stringrequired
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/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.