Version: Dev

AISIX Enterprise / Cloud Admin API Changelog

AISIX Enterprise and AISIX Cloud share a versioned, organization-scoped Admin API. Most operations are available in both products; each contract identifies product-specific operations.

For AISIX Enterprise, choose the contract matching the installed control-plane release. AISIX Cloud normally uses the latest released contract. The changelog compares adjacent releases: Breaking changes require caller updates, and product-availability changes are listed separately.

API references: 1.7.1, 1.7.0, 1.6.0, 1.5.0, 1.4.0, 1.3.0, 1.2.0, 1.1.0, 1.0.0

From 1.7.0 to 1.7.1

Switch to Show all to see all changes

POST/environments/{env_id}/models

Request Body
- Modifiedpropertyauto_prompt_caching
  - Schemas added: #/components/schemas/AutoPromptCachingConfig
  - Type changed from 'object' to ''
  - AdditionalProperties changed from false to null
  - Nullable changed from false to true
  - Deletedpropertyenabled
  - Deletedpropertyttl
- Modifiedpropertycooldown
  - Schemas added: #/components/schemas/CooldownConfig
  - Type changed from 'object' to ''
  - AdditionalProperties changed from false to null
  - Nullable changed from false to true
  - Deletedpropertydefault_seconds
  - Deletedpropertyenabled
  - Deletedpropertyhonor_retry_after
  - Deletedpropertymax_seconds
  - Deletedpropertytrigger_on_timeout
  - Deletedpropertytrigger_on_transport
  - Deletedpropertytrigger_statuses

PATCH/environments/{env_id}/models/{model_id}

Request Body
- Modifiedpropertyauto_prompt_caching
  - Schemas added: #/components/schemas/AutoPromptCachingConfig
  - Type changed from 'object' to ''
  - AdditionalProperties changed from false to null
  - Nullable changed from false to true
  - Deletedpropertyenabled
  - Deletedpropertyttl
- Modifiedpropertycooldown
  - Schemas added: #/components/schemas/CooldownConfig
  - Type changed from 'object' to ''
  - AdditionalProperties changed from false to null
  - Nullable changed from false to true
  - Deletedpropertydefault_seconds
  - Deletedpropertyenabled
  - Deletedpropertyhonor_retry_after
  - Deletedpropertymax_seconds
  - Deletedpropertytrigger_on_timeout
  - Deletedpropertytrigger_on_transport
  - Deletedpropertytrigger_statuses

From 1.6.0 to 1.7.0

GET/tag_keys

POST/tag_keys

DELETE/tag_keys/{key}

GET/tag_keys/{key}

PATCH/tag_keys/{key}

GET/tag_keys/{key}/values

GET/usage_analysis

GET/usage_analysis/tag_keys

Switch to Show all to see all changes

GET/budgets

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Modifiedpropertybudget
        Modifiedpropertyscope
        New enum values: [tag]

POST/budgets

Request Body
- Modifiedpropertyscope
  - New enum values: [tag]
Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertybudget
    - Modifiedpropertyscope
      - New enum values: [tag]

GET/budgets/{budget_id}

Responses
- Modified response: 200
  - Modifiedpropertybudget
    - Modifiedpropertyscope
      - New enum values: [tag]

PATCH/budgets/{budget_id}

Responses
- Modified response: 200
  - Modifiedpropertybudget
    - Modifiedpropertyscope
      - New enum values: [tag]

GET/data_export

Responses
- New response: 404

POST/data_import

Responses
- New response: 404

GET/environments/{env_id}/api_keys

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertytags

POST/environments/{env_id}/api_keys

Request Body
- Newpropertytags
Responses
- Modified response: 201
  - Modifiedpropertyapi_key
    - Newpropertytags

PATCH/environments/{env_id}/api_keys/{api_key_id}

Request Body
- Newpropertytags
Responses
- Modified response: 200
  - Modifiedpropertyapi_key
    - Newpropertytags

POST/environments/{env_id}/api_keys/{api_key_id}/rotate

Responses
- Modified response: 200
  - Modifiedpropertyapi_key
    - Newpropertytags

GET/environments/{env_id}/models

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertyoff_peak
      - Newpropertyprice

POST/environments/{env_id}/models

Request Body
- Newpropertyoff_peak
- Newpropertyprice
Responses
- Modified response: 201
  - Modifiedpropertymodel
    - Newpropertyoff_peak
    - Newpropertyprice

GET/environments/{env_id}/models/{model_id}

Responses
- Modified response: 200
  - Modifiedpropertymodel
    - Newpropertyoff_peak
    - Newpropertyprice

PATCH/environments/{env_id}/models/{model_id}

Request Body
- Newpropertyoff_peak
- Newpropertyprice
Responses
- Modified response: 200
  - Modifiedpropertymodel
    - Newpropertyoff_peak
    - Newpropertyprice

GET/environments/{env_id}/observability_exporters

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertyrequest_headers
      - Newpropertyupstream_response_headers

POST/environments/{env_id}/observability_exporters

Request Body
- Newpropertyrequest_headers
- Newpropertyupstream_response_headers
Responses
- Modified response: 201
  - Newpropertywarnings
  - Modifiedpropertyobservability_exporter
    - Newpropertyrequest_headers
    - Newpropertyupstream_response_headers

GET/environments/{env_id}/observability_exporters/{exporter_id}

Responses
- Modified response: 200
  - Newpropertywarnings
  - Modifiedpropertyobservability_exporter
    - Newpropertyrequest_headers
    - Newpropertyupstream_response_headers

PATCH/environments/{env_id}/observability_exporters/{exporter_id}

Request Body
- Newpropertyrequest_headers
- Newpropertyupstream_response_headers
Responses
- Modified response: 200
  - Newpropertywarnings
  - Modifiedpropertyobservability_exporter
    - Newpropertyrequest_headers
    - Newpropertyupstream_response_headers

GET/environments/{env_id}/rate_limits

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Modifiedpropertyconditions
        Items changed
        Modifiedpropertydimension
        Schemas added: subschema #1, subschema #2
        Deleted enum values: [team member api_key model model_name provider]
      - Modifiedpropertygroup_by
        Items changed
        Schemas added: subschema #1, subschema #2
        Deleted enum values: [team member api_key model provider]

POST/environments/{env_id}/rate_limits

Request Body
- Modifiedpropertyconditions
  - Items changed
    - Modifiedpropertydimension
      - Schemas added: subschema #1, subschema #2
      - Deleted enum values: [team member api_key model model_name provider]
- Modifiedpropertygroup_by
  - Items changed
    - Schemas added: subschema #1, subschema #2
    - Deleted enum values: [team member api_key model provider]
Responses
- Modified response: 201
  - Modifiedpropertyrate_limit_policy
    - Modifiedpropertyconditions
      - Items changed
        Modifiedpropertydimension
        Schemas added: subschema #1, subschema #2
        Deleted enum values: [team member api_key model model_name provider]
    - Modifiedpropertygroup_by
      - Items changed
        Schemas added: subschema #1, subschema #2
        Deleted enum values: [team member api_key model provider]

GET/environments/{env_id}/rate_limits/{rate_limit_id}

Responses
- Modified response: 200
  - Modifiedpropertyrate_limit_policy
    - Modifiedpropertyconditions
      - Items changed
        Modifiedpropertydimension
        Schemas added: subschema #1, subschema #2
        Deleted enum values: [team member api_key model model_name provider]
    - Modifiedpropertygroup_by
      - Items changed
        Schemas added: subschema #1, subschema #2
        Deleted enum values: [team member api_key model provider]

PATCH/environments/{env_id}/rate_limits/{rate_limit_id}

Request Body
- Modifiedpropertyconditions
  - Items changed
    - Modifiedpropertydimension
      - Schemas added: subschema #1, subschema #2
      - Deleted enum values: [team member api_key model model_name provider]
- Modifiedpropertygroup_by
  - Items changed
    - Schemas added: subschema #1, subschema #2
    - Deleted enum values: [team member api_key model provider]
Responses
- Modified response: 200
  - Modifiedpropertyrate_limit_policy
    - Modifiedpropertyconditions
      - Items changed
        Modifiedpropertydimension
        Schemas added: subschema #1, subschema #2
        Deleted enum values: [team member api_key model model_name provider]
    - Modifiedpropertygroup_by
      - Items changed
        Schemas added: subschema #1, subschema #2
        Deleted enum values: [team member api_key model provider]

GET/environments/{env_id}/usage_events

Newquery paraminclude_total
Responses
- Modified response: 200
  - Required changed
    - Deleted required property: total
  - Modifiedpropertydata
    - Items changed
      - Newpropertycache_creation_1h_tokens
      - Newpropertycache_creation_5m_tokens
      - Newpropertyservice_tier
      - Newpropertytags
      - Newpropertyteam_id
      - Modifiedpropertyoperation
        New enum values: [systemone decisions]

GET/environments/{env_id}/usage_events/export

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Modified schema: #/components/schemas/UsageEvent
        Newpropertycache_creation_1h_tokens
        Newpropertycache_creation_5m_tokens
        Newpropertyservice_tier
        Newpropertytags
        Newpropertyteam_id
        Modifiedpropertyoperation
        New enum values: [systemone decisions]

GET/environments/{env_id}/usage_metrics

Responses
- Modified response: 200
  - Required changed
    - Newrequired propertybackfill_in_progress
  - Newpropertybackfill_in_progress

GET/environments/{env_id}/usage_summary

Responses
- Modified response: 200
  - Required changed
    - Newrequired propertybackfill_in_progress
  - Newpropertybackfill_in_progress
  - Modifiedpropertydata
    - Items changed
      - Newpropertyapi_key_name

GET/members

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertytags

POST/members

Request Body
- Newpropertytags
Responses
- Modified response: 201
  - Modifiedpropertymember
    - Newpropertytags

PATCH/members/{user_id}

Request Body
- Required changed
  - Deleted required property: role
- MinProps changed from 0 to 1
- Newpropertytags
Responses
- Modified response: 200
  - Modifiedpropertymember
    - Required changed
      - Newrequired propertytags
    - Newpropertytags

GET/model_pricing

Newquery paramview
Responses
- Modified response: 200
  - Newpropertycurrency
  - Newpropertymodel_groups
  - Newpropertyunpriced
  - Modifiedpropertydata
    - Items changed
      - Newpropertycache_write_1h_usd_per_1m
      - Newpropertydecisions
      - Newpropertyservice_tier_prices
      - Newpropertytiers

PUT/model_pricing

Request Body
- Newpropertycache_write_1h_usd_per_1m
- Newpropertydecisions
- Newpropertyservice_tier_prices
- Newpropertytiers
Responses
- Modified response: 200
  - Modifiedpropertymodel_pricing
    - Newpropertycache_write_1h_usd_per_1m
    - Newpropertydecisions
    - Newpropertyservice_tier_prices
    - Newpropertytiers

PUT/model_pricing/precise

Request Body
- Newpropertycache_write_1h_usd_per_1m
- Newpropertydecisions
- Newpropertyservice_tier_prices
- Newpropertytiers
Responses
- Modified response: 200
  - Modifiedpropertymodel_pricing
    - Newpropertycache_write_1h_usd_per_1m
    - Newpropertydecisions
    - Newpropertyservice_tier_prices
    - Newpropertytiers

GET/provider_keys/{provider_key_id}

Responses
- Modified response: 200
  - Modifiedpropertyprovider_key
    - Newpropertybedrock_auth_type

PATCH/provider_keys/{provider_key_id}

Responses
- Modified response: 200
  - Modifiedpropertyprovider_key
    - Newpropertybedrock_auth_type

POST/roles

Request Body
- Modifiedpropertypermissions
  - Items changed
    - Modified schema: #/components/schemas/RoleReadPermissionInput
      - Modifiedpropertyresource
        New enum values: [tag_keys]
    - Modified schema: #/components/schemas/RoleWritePermissionInput
      - Modifiedpropertyresource
        New enum values: [tag_keys]

PATCH/roles/{role_name}

Request Body
- Modifiedpropertypermissions
  - Items changed
    - Modified schema: #/components/schemas/RoleReadPermissionInput
      - Modifiedpropertyresource
        New enum values: [tag_keys]
    - Modified schema: #/components/schemas/RoleWritePermissionInput
      - Modifiedpropertyresource
        New enum values: [tag_keys]

GET/teams

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertytags

POST/teams

Request Body
- Newpropertytags
Responses
- Modified response: 201
  - Modifiedpropertyteam
    - Newpropertytags

GET/teams/{team_id}

Responses
- Modified response: 200
  - Modifiedpropertyteam
    - Newpropertytags

PATCH/teams/{team_id}

Request Body
- Newpropertytags
Responses
- Modified response: 200
  - Modifiedpropertyteam
    - Newpropertytags

From 1.5.0 to 1.6.0

POST/invitations/{invitation_id}/resend

POST/members/{user_id}/set_password_link

PUT/model_pricing/precise

GET/pending_members

Switch to Show all to see all changes

POST/data_import

Responses
- Modified response: 200
  - Required changed
    - Deleted required property: owner_user_id
  - Deletedpropertyowner_user_idBreaking
Security changed
- New security requirements: BearerConsoleSession
- New security requirements: ConsoleSession
- Deleted security requirements:
- Deleted security requirements: BearerAdminToken

GET/environments/{env_id}/models

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertyplayground_chat_capable
      - Modifiedpropertysemantic
        Required changed
        Deleted required property: embedding_model_id
        Deleted required property: threshold
        Newpropertyclassifier
        Modifiedpropertyroutes
        Items changed
        Required changed
        Deleted required property: examples

POST/environments/{env_id}/models

Request Body
- Modifiedpropertysemantic
  - Required changed
    - Deleted required property: embedding_model_id
    - Deleted required property: threshold
  - Newpropertyclassifier
  - Modifiedpropertyroutes
    - Items changed
      - Required changed
        Deleted required property: examples
Responses
- Modified response: 201
  - Modifiedpropertymodel
    - Newpropertyplayground_chat_capable
    - Modifiedpropertysemantic
      - Required changed
        Deleted required property: embedding_model_id
        Deleted required property: threshold
      - Newpropertyclassifier
      - Modifiedpropertyroutes
        Items changed
        Required changed
        Deleted required property: examples

GET/environments/{env_id}/models/{model_id}

Responses
- Modified response: 200
  - Modifiedpropertymodel
    - Newpropertyplayground_chat_capable
    - Modifiedpropertysemantic
      - Required changed
        Deleted required property: embedding_model_id
        Deleted required property: threshold
      - Newpropertyclassifier
      - Modifiedpropertyroutes
        Items changed
        Required changed
        Deleted required property: examples

PATCH/environments/{env_id}/models/{model_id}

Request Body
- Modifiedpropertysemantic
  - Required changed
    - Deleted required property: embedding_model_id
    - Deleted required property: threshold
  - Newpropertyclassifier
  - Modifiedpropertyroutes
    - Items changed
      - Required changed
        Deleted required property: examples
Responses
- Modified response: 200
  - Modifiedpropertymodel
    - Newpropertyplayground_chat_capable
    - Modifiedpropertysemantic
      - Required changed
        Deleted required property: embedding_model_id
        Deleted required property: threshold
      - Newpropertyclassifier
      - Modifiedpropertyroutes
        Items changed
        Required changed
        Deleted required property: examples

GET/environments/{env_id}/usage_events

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertygateway_embedding_calls
      - Newpropertygateway_embedding_calls_dropped

GET/environments/{env_id}/usage_events/export

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Modified schema: #/components/schemas/UsageEvent
        Newpropertygateway_embedding_calls
        Newpropertygateway_embedding_calls_dropped

POST/invitations

Responses
- New response: 429
- Modified response: 201
  - Required changed
    - Newrequired propertyemail_delivery
  - Newpropertyemail_delivery

GET/members

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertysign_in_methods

POST/members

Responses
- New response: 404
- Modified response: 201
  - Modifiedpropertymember
    - Newpropertysign_in_methods

GET/model_pricing

Newquery parammodel
Newquery parampage
Newquery parampage_size
Newquery paramq
Newquery paramsection
Responses
- New response: 400
- Modified response: 200
  - Newpropertypage
  - Newpropertypage_size
  - Newpropertytotal
  - Modifiedpropertydata
    - Items changed
      - Newpropertycache_read_usd_per_1m
      - Newpropertycache_write_usd_per_1m
      - Newpropertycompletion_usd_per_1m
      - Newpropertyprompt_usd_per_1m
      - Newpropertyreasoning_usd_per_1m
      - Modifiedpropertycache_read_cents_per_1m
        Deprecated changed from false to true
      - Modifiedpropertycache_write_cents_per_1m
        Deprecated changed from false to true
      - Modifiedpropertycompletion_cents_per_1m
        Deprecated changed from false to true
      - Modifiedpropertyprompt_cents_per_1m
        Deprecated changed from false to true
      - Modifiedpropertyreasoning_cents_per_1m
        Deprecated changed from false to true

PUT/model_pricing

Request Body
- Newpropertycache_read_usd_per_1m
- Newpropertycache_write_usd_per_1m
- Newpropertycompletion_usd_per_1m
- Newpropertyprompt_usd_per_1m
- Newpropertyreasoning_usd_per_1m
- Modifiedpropertycache_read_cents_per_1m
  - Deprecated changed from false to true
- Modifiedpropertycache_write_cents_per_1m
  - Deprecated changed from false to true
- Modifiedpropertycompletion_cents_per_1m
  - Deprecated changed from false to true
- Modifiedpropertyprompt_cents_per_1m
  - Deprecated changed from false to true
- Modifiedpropertyreasoning_cents_per_1m
  - Deprecated changed from false to true
Responses
- Modified response: 200
  - Modifiedpropertymodel_pricing
    - Newpropertycache_read_usd_per_1m
    - Newpropertycache_write_usd_per_1m
    - Newpropertycompletion_usd_per_1m
    - Newpropertyprompt_usd_per_1m
    - Newpropertyreasoning_usd_per_1m
    - Modifiedpropertycache_read_cents_per_1m
      - Deprecated changed from false to true
    - Modifiedpropertycache_write_cents_per_1m
      - Deprecated changed from false to true
    - Modifiedpropertycompletion_cents_per_1m
      - Deprecated changed from false to true
    - Modifiedpropertyprompt_cents_per_1m
      - Deprecated changed from false to true
    - Modifiedpropertyreasoning_cents_per_1m
      - Deprecated changed from false to true

Product availability changes

POST /members: AISIX Enterprise and AISIX Cloud → AISIX Enterprise only
POST /members/{user_id}/set_password_link: not present → AISIX Enterprise only
GET /data_export: AISIX Enterprise and AISIX Cloud → AISIX Enterprise only
POST /data_import: AISIX Enterprise and AISIX Cloud → AISIX Enterprise only

From 1.4.0 to 1.5.0

Switch to Show all to see all changes

GET/budgets

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Modifiedpropertystate
        Modified schema: #/components/schemas/BudgetState
        Required changed
        Newrequired propertyaggregated_at
        Newpropertyaggregated_at

GET/budgets/{budget_id}

Responses
- Modified response: 200
  - Modifiedpropertystate
    - Modified schema: #/components/schemas/BudgetState
      - Required changed
        Newrequired propertyaggregated_at
      - Newpropertyaggregated_at

GET/environments/{env_id}/oidc_providers

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Required changed
        Newrequired propertyhmac_secret_set
        Deleted required property: issuer
      - Newpropertyhmac_secret_set
      - ModifiedpropertyaudiencesBreaking
        MinItems changed from 1 to 0

POST/environments/{env_id}/oidc_providers

Request Body
- Required changed
  - Deleted required property: audiences
  - Deleted required property: issuer
- Newpropertyhmac_secret
- ModifiedpropertyaudiencesBreaking
  - MinItems changed from 1 to 0
Responses
- Modified response: 201
  - Modifiedpropertyoidc_provider
    - Required changed
      - Newrequired propertyhmac_secret_set
      - Deleted required property: issuer
    - Newpropertyhmac_secret_set
    - ModifiedpropertyaudiencesBreaking
      - MinItems changed from 1 to 0

GET/environments/{env_id}/oidc_providers/{oidc_provider_id}

Responses
- Modified response: 200
  - Modifiedpropertyoidc_provider
    - Required changed
      - Newrequired propertyhmac_secret_set
      - Deleted required property: issuer
    - Newpropertyhmac_secret_set
    - ModifiedpropertyaudiencesBreaking
      - MinItems changed from 1 to 0

PATCH/environments/{env_id}/oidc_providers/{oidc_provider_id}

Request Body
- Newpropertyhmac_secret
- ModifiedpropertyaudiencesBreaking
  - Nullable changed from false to true
  - MinItems changed from 1 to 0
- ModifiedpropertyissuerBreaking
  - Nullable changed from false to true
Responses
- Modified response: 200
  - Modifiedpropertyoidc_provider
    - Required changed
      - Newrequired propertyhmac_secret_set
      - Deleted required property: issuer
    - Newpropertyhmac_secret_set
    - ModifiedpropertyaudiencesBreaking
      - MinItems changed from 1 to 0

GET/environments/{env_id}/usage_events

Newquery paramguardrail_blocked_fail_closed
Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Required changed
        Newrequired propertyguardrail_blocked_fail_closed
      - Newpropertyguardrail_blocked_fail_closed
      - Newpropertytotal_tokens
      - Modifiedpropertyguardrail_enforced_hits
        Items changed
        Modifiedpropertyaction
        New enum values: [blocked_buffer_exceeded mask_unsupported]
      - Modifiedpropertyguardrail_monitor_hits
        Items changed
        Modifiedpropertyaction
        New enum values: [would_block would_mask would_mask_unsupported]

GET/environments/{env_id}/usage_events/export

Newquery paramguardrail_blocked_fail_closed
Newquery paramtimezone
Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Modified schema: #/components/schemas/UsageEvent
        Required changed
        Newrequired propertyguardrail_blocked_fail_closed
        Newpropertyguardrail_blocked_fail_closed
        Newpropertytotal_tokens
        Modifiedpropertyguardrail_enforced_hits
        Items changed
        Modifiedpropertyaction
        New enum values: [blocked_buffer_exceeded mask_unsupported]
        Modifiedpropertyguardrail_monitor_hits
        Items changed
        Modifiedpropertyaction
        New enum values: [would_block would_mask would_mask_unsupported]

GET/environments/{env_id}/usage_summary

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Required changed
        Newrequired propertytotal_tokens
      - Newpropertytotal_tokens

POST/provider_keys

Request Body
- Modifiedpropertyapi_base
  - Pattern changed from '^($|[Hh][Tt][Tt][Pp][Ss]?://(?:%[0-9A-Fa-f]{2}|[^s%/?#@:])(?:[^s%/?#@]|%[0-9A-Fa-f]{2})(?:/(?:[^s%?#]|%[0-9A-Fa-f]{2}))?)$' to '^($|[Hh][Tt][Tt][Pp][Ss]?://(?:(?:[^s%/?#@]|%[0-9A-Fa-f]{2})@)?(?:%[0-9A-Fa-f]{2}|[^s%/?#@:])(?:[^s%/?#@]|%[0-9A-Fa-f]{2})(?:/(?:[^s%?#]|%[0-9A-Fa-f]{2})*)?)$'

GET/provider_keys/{provider_key_id}

Responses
- Modified response: 200
  - Modifiedpropertyprovider_key
    - Modifiedpropertyapi_base
      - Pattern changed from '^($|[Hh][Tt][Tt][Pp][Ss]?://(?:%[0-9A-Fa-f]{2}|[^s%/?#@:])(?:[^s%/?#@]|%[0-9A-Fa-f]{2})(?:/(?:[^s%?#]|%[0-9A-Fa-f]{2}))?)$' to '^($|[Hh][Tt][Tt][Pp][Ss]?://(?:(?:[^s%/?#@]|%[0-9A-Fa-f]{2})@)?(?:%[0-9A-Fa-f]{2}|[^s%/?#@:])(?:[^s%/?#@]|%[0-9A-Fa-f]{2})(?:/(?:[^s%?#]|%[0-9A-Fa-f]{2})*)?)$'

PATCH/provider_keys/{provider_key_id}

Request Body
- Modifiedpropertyapi_base
  - Pattern changed from '^($|[Hh][Tt][Tt][Pp][Ss]?://(?:%[0-9A-Fa-f]{2}|[^s%/?#@:])(?:[^s%/?#@]|%[0-9A-Fa-f]{2})(?:/(?:[^s%?#]|%[0-9A-Fa-f]{2}))?)$' to '^($|[Hh][Tt][Tt][Pp][Ss]?://(?:(?:[^s%/?#@]|%[0-9A-Fa-f]{2})@)?(?:%[0-9A-Fa-f]{2}|[^s%/?#@:])(?:[^s%/?#@]|%[0-9A-Fa-f]{2})(?:/(?:[^s%?#]|%[0-9A-Fa-f]{2})*)?)$'
Responses
- Modified response: 200
  - Modifiedpropertyprovider_key
    - Modifiedpropertyapi_base
      - Pattern changed from '^($|[Hh][Tt][Tt][Pp][Ss]?://(?:%[0-9A-Fa-f]{2}|[^s%/?#@:])(?:[^s%/?#@]|%[0-9A-Fa-f]{2})(?:/(?:[^s%?#]|%[0-9A-Fa-f]{2}))?)$' to '^($|[Hh][Tt][Tt][Pp][Ss]?://(?:(?:[^s%/?#@]|%[0-9A-Fa-f]{2})@)?(?:%[0-9A-Fa-f]{2}|[^s%/?#@:])(?:[^s%/?#@]|%[0-9A-Fa-f]{2})(?:/(?:[^s%?#]|%[0-9A-Fa-f]{2})*)?)$'

From 1.3.0 to 1.4.0

From 1.2.0 to 1.3.0

GET/data_export

POST/data_import

GET/notification_deliveries/{delivery_id}

Switch to Show all to see all changes

GET/environments/{env_id}/guardrails

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertyinput_messages

POST/environments/{env_id}/guardrails

Request Body
- Newpropertyinput_messages
Responses
- Modified response: 201
  - Modifiedpropertyguardrail
    - Newpropertyinput_messages

GET/environments/{env_id}/guardrails/{guardrail_id}

Responses
- Modified response: 200
  - Modifiedpropertyguardrail
    - Newpropertyinput_messages

PATCH/environments/{env_id}/guardrails/{guardrail_id}

Request Body
- Newpropertyinput_messages
Responses
- Modified response: 200
  - Modifiedpropertyguardrail
    - Newpropertyinput_messages

GET/environments/{env_id}/models

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Modifiedpropertyeffort_mapping
        AdditionalProperties changed
        Nullable changed from false to true
        MinLength changed from 0 to 1

POST/environments/{env_id}/models

Request Body
- Modifiedpropertyeffort_mapping
  - Modified schema: #/components/schemas/EffortMapping
    - AdditionalProperties changed
      - Nullable changed from false to true
      - MinLength changed from 0 to 1
Responses
- Modified response: 201
  - Modifiedpropertymodel
    - Modifiedpropertyeffort_mapping
      - AdditionalProperties changed
        Nullable changed from false to true
        MinLength changed from 0 to 1

GET/environments/{env_id}/models/{model_id}

Responses
- Modified response: 200
  - Modifiedpropertymodel
    - Modifiedpropertyeffort_mapping
      - AdditionalProperties changed
        Nullable changed from false to true
        MinLength changed from 0 to 1

PATCH/environments/{env_id}/models/{model_id}

Request Body
- Modifiedpropertyeffort_mapping
  - Modified schema: #/components/schemas/EffortMapping
    - AdditionalProperties changed
      - Nullable changed from false to true
      - MinLength changed from 0 to 1
Responses
- Modified response: 200
  - Modifiedpropertymodel
    - Modifiedpropertyeffort_mapping
      - AdditionalProperties changed
        Nullable changed from false to true
        MinLength changed from 0 to 1

GET/notification_channels

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Required changed
        Newrequired propertybody_template
        Newrequired propertyheaders
      - Newpropertybody_template
      - Newpropertyheaders

POST/notification_channels

Request Body
- Newpropertybody_template
- Newpropertyheaders
Responses
- Modified response: 201
  - Modifiedpropertynotification_channel
    - Required changed
      - Newrequired propertybody_template
      - Newrequired propertyheaders
    - Newpropertybody_template
    - Newpropertyheaders

GET/notification_channels/{channel_id}

Responses
- Modified response: 200
  - Modifiedpropertynotification_channel
    - Required changed
      - Newrequired propertybody_template
      - Newrequired propertyheaders
    - Newpropertybody_template
    - Newpropertyheaders

PATCH/notification_channels/{channel_id}

Request Body
- Newpropertybody_template
- Newpropertyheaders
Responses
- Modified response: 200
  - Modifiedpropertynotification_channel
    - Required changed
      - Newrequired propertybody_template
      - Newrequired propertyheaders
    - Newpropertybody_template
    - Newpropertyheaders

POST/notification_channels/{channel_id}/test

Responses
- Modified response: 200
  - Newpropertyrequest_body
  - Newpropertyresponse_body
  - Newpropertyresponse_status

GET/notification_deliveries

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Required changed
        Newrequired propertylast_response_body
        Newrequired propertylast_response_body_truncated
        Newrequired propertylast_response_status
      - Newpropertylast_response_body
      - Newpropertylast_response_body_truncated
      - Newpropertylast_response_status

POST/provider_keys

Request Body
- Newpropertyresolve_addresses

GET/provider_keys/{provider_key_id}

Responses
- Modified response: 200
  - Modifiedpropertyprovider_key
    - Newpropertyresolve_addresses

PATCH/provider_keys/{provider_key_id}

Request Body
- Newpropertyresolve_addresses
Responses
- Modified response: 200
  - Modifiedpropertyprovider_key
    - Newpropertyresolve_addresses

POST/roles

Request Body
- Modifiedpropertypermissions
  - Items changed
    - Modified schema: #/components/schemas/RoleReadPermissionInput
      - Modifiedpropertyresource
        New enum values: [data_export]

PATCH/roles/{role_name}

Request Body
- Modifiedpropertypermissions
  - Items changed
    - Modified schema: #/components/schemas/RoleReadPermissionInput
      - Modifiedpropertyresource
        New enum values: [data_export]

From 1.1.0 to 1.2.0

Switch to Show all to see all changes

POST/a2a_agents

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/a2a_agents/{a2a_agent_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/a2a_agents/{a2a_agent_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/environments/{env_id}

Responses
- New response: 422

POST/environments/{env_id}/api_keys

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/api_keys/{api_key_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/environments/{env_id}/api_keys/{api_key_id}/rotate

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/environments/{env_id}/cache_policies

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/environments/{env_id}/cache_policies/{cache_policy_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/cache_policies/{cache_policy_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/environments/{env_id}/cache_policies/{cache_policy_id}/purge

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/environments/{env_id}/claim_mappings

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/environments/{env_id}/claim_mappings/{claim_mapping_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/claim_mappings/{claim_mapping_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/environments/{env_id}/guardrails

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/environments/{env_id}/guardrails/{guardrail_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/guardrails/{guardrail_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/environments/{env_id}/guardrails/{guardrail_id}/attachments

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PUT/environments/{env_id}/mcp_policy

Responses
- New response: 422

POST/environments/{env_id}/models

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/environments/{env_id}/models/{model_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/models/{model_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/environments/{env_id}/observability_exporters

Responses
- New response: 422

PATCH/environments/{env_id}/observability_exporters/{exporter_id}

Responses
- New response: 422

POST/environments/{env_id}/oidc_providers

Responses
- New response: 422

PATCH/environments/{env_id}/oidc_providers/{oidc_provider_id}

Responses
- New response: 422

POST/environments/{env_id}/passthrough_routes

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/environments/{env_id}/passthrough_routes/{passthrough_route_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/passthrough_routes/{passthrough_route_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/environments/{env_id}/rate_limits

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/environments/{env_id}/rate_limits/{rate_limit_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/rate_limits/{rate_limit_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/environments/{env_id}/usage_events

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertycache_write_tokens

GET/environments/{env_id}/usage_events/export

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Modified schema: #/components/schemas/UsageEvent
        Newpropertycache_write_tokens

POST/mcp_server_submissions

Responses
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/mcp_server_submissions/{mcp_server_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/mcp_servers

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/mcp_servers/{mcp_server_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/mcp_servers/{mcp_server_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/mcp_servers/{mcp_server_id}/approve

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

POST/mcp_servers/{mcp_server_id}/reject

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PUT/model_pricing

Responses
- New response: 422

POST/provider_keys

Responses
- New response: 422
- Modified response: 201
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

GET/provider_keys/{provider_key_id}

Responses
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

PATCH/provider_keys/{provider_key_id}

Responses
- New response: 422
- Modified response: 200
  - Modifiedpropertywarnings
    - Items changed
      - Modifiedpropertycode
        New enum values: [below_floor]
        Deleted enum values: [row_rejected]

From 1.0.0 to 1.1.0

Switch to Show all to see all changes

GET/a2a_agents

Responses
- Modified response: 200
  - Modifiedpropertydata
    - Items changed
      - Newpropertyforward_client_headers

POST/a2a_agents

Request Body
- Newpropertyforward_client_headers
Responses
- Modified response: 201
  - Newpropertywarnings
  - Modifiedpropertya2a_agent
    - Newpropertyforward_client_headers

GET/a2a_agents/{a2a_agent_id}

Responses
- Modified response: 200
  - Newpropertywarnings
  - Modifiedpropertya2a_agent
    - Newpropertyforward_client_headers

PATCH/a2a_agents/{a2a_agent_id}

Request Body
- Newpropertyforward_client_headers
Responses
- Modified response: 200
  - Newpropertywarnings
  - Modifiedpropertya2a_agent
    - Newpropertyforward_client_headers

From 1.7.0 to 1.7.1​

Modified20 Breakings

From 1.6.0 to 1.7.0​

New8

Modified400 Breakings

From 1.5.0 to 1.6.0​

New4

Modified120 Breakings

Product availability changes​

From 1.4.0 to 1.5.0​

Modified120 Breakings

From 1.3.0 to 1.4.0​

From 1.2.0 to 1.3.0​

New3

Modified190 Breakings

From 1.1.0 to 1.2.0​

Modified450 Breakings

From 1.0.0 to 1.1.0​

Modified40 Breakings

From 1.7.0 to 1.7.1

From 1.6.0 to 1.7.0

From 1.5.0 to 1.6.0

Product availability changes

From 1.4.0 to 1.5.0

From 1.3.0 to 1.4.0

From 1.2.0 to 1.3.0

From 1.1.0 to 1.2.0

From 1.0.0 to 1.1.0