Trigger a manual model catalog sync

POST /api/model_catalogs/sync

Interactive request editor loads with JavaScript.

Request Body

application/json

Empty request body reserved for future manual sync options.

Response Body

`application/json`

curl -X POST "$API_BASE_URL/api/model_catalogs/sync" \  -H "Content-Type: application/json" \  -d '{}'

Successfully completed the manual model catalog sync request.

{
  "value": {
    "success": true,
    "error_message": "unexpected HTTP status: 503",
    "http_status": 200,
    "duration_ms": 431,
    "diff": [
      {
        "op": "add",
        "path": "/name",
        "value": "new-name"
      }
    ],
    "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"
  }
}

Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

{
  "value": {},
  "error_msg": "error message"
}

Conflict — A resource with the same unique identifier (e.g., name) already exists.

{
  "value": {},
  "error_msg": "error message"
}

Complete operation details and schema variants

IAM Action: ai_gateway:SyncModelCatalog, Resource: arn:api7:ai_gateway:modelcatalog/* Triggers an immediate synchronization against the configured upstream model catalog endpoint. Remote fetch failures are returned as HTTP 200 with success=false; HTTP 409 is reserved for concurrent sync attempts.

Parameters

Request body

Content type: application/json

Responses

200: Successfully completed the manual model catalog sync request.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional): Structured result returned by the manual sync API.
value.success (boolean, optional): Whether the synchronization completed successfully.
value.error_message (string, optional): Error summary for failed manual sync attempts.
value.http_status (integer,null, optional): HTTP status code returned by the upstream source, when available.
value.duration_ms (integer, optional): Total elapsed time of the synchronization run in milliseconds.
value.diff (object, optional): JSON Patch snapshot diff for successful syncs.
allOf variant 1
oneOf variant 1: add/replace
value.diff[].op (string, required): The operation to be performed.
value.diff[].path (string, required): Path to the field to be replaced or added. Path should follow the JSON Pointer format.
value.diff[].value (object, required): Value to be added or replaced.
oneOf variant 2: remove
value.diff[].op (string, required): The operation to be performed.
value.diff[].path (string, required): Path to the field to be removed. Path should follow the JSON Pointer format.
value.id (string, optional): The object ID.
400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
value (object, optional): The specific resource.
error_msg (string, optional): The error message.
409: Conflict — A resource with the same unique identifier (e.g., name) already exists. Response fields (application/json): identical to POST /api/model_catalogs/sync, response 400 above.

cURL

curl -X POST '$API_BASE_URL/api/model_catalogs/sync'

Trigger a manual model catalog sync

200application/json

400application/json

409application/json

`application/json`

`application/json`

`application/json`