Align the environment's models with the catalogue

Back-fills catalog_id by name once, then applies the catalogue to the linked models: recommended metrics, end_of_life, the forced tool_choice refusal and the mid-conversation system refusal (filled only when the model has no value, else reported as divergent), exclude_params / rename_params (filled only when empty, else reported as divergent), limits.max_response_tokens, the capabilities flags (text, vision, image, audio, file.enabled; a file.max_size above 0 is kept; before/after list the changed flags only), limits.context (filled only when empty, else reported as divergent). On every model (field region), clears a stored carbon region that changes nothing to the footprint — equal to what the provider entry gives (or the default when it gives none), or unknown — so it follows the provider again; a region that differs is an override and is kept. limits.response_tokens is never synced. Dry-run by default. Requires write access to models.

POST /v1/models/catalog/sync

Align the environment's models with the catalogue

cURL

curl --request POST \
  --url https://{host}/v2/workspaces/slug:llm-gateway/webhooks/v1/models/catalog/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dry_run": true,
  "model_ids": [
    "<string>"
  ],
  "fields": [
    "<string>"
  ]
}
'

200

{
  "dry_run": true,
  "fields": [
    "<string>"
  ],
  "summary": {},
  "backfilled": [
    {}
  ],
  "patched": [
    {}
  ],
  "unmatched": [
    {}
  ],
  "divergent": [
    {}
  ],
  "warnings": [
    {}
  ],
  "failed": [
    {}
  ]
}

Authorizations

BearerAuthOrgApiKeyAuth

Authorization · string · header · required

User-bound credential carrying an identity: either a session JWT or a user access token (at:*) generated from the user settings UI. Send as Authorization: Bearer <token>. Org API keys (iak_*) are not accepted here - they carry no user identity. Use the x-prismeai-api-key header instead (see OrgApiKeyAuth).

Body

application/json

dry_run · boolean · default: true

model_ids · string[]

fields · string[]

Response

200

application/json

What was (or would be) changed.

dry_run · boolean

fields · string[]

summary · object

backfilled · object[]

patched · object[]

unmatched · object[]

divergent · object[]

warnings · object[]

Reported, never changed: {model_id, code, provider, message}. OUTPUT_LIMIT_DROPPED = a completion model whose provider entry or own exclude_params exclude max_tokens (and not max_completion_tokens) with nothing renaming it, so its calls go out without an output limit.

failed · object[]

Models whose write failed (dry_run: false), as {model_id, catalog_id, fields, error}; each also emits an error event ModelCatalogSyncWriteFailed.