Model Inventory

Update a model inventory by ID

Changed on

Partially updates a model inventory record. All body fields are optional; only provided fields are changed. Project and framework associations can be replaced or cleared. Fires "model_updated" automations and notifies a new approver if changed.

patch/modelInventory/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/modelInventory/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

Model inventory ID

Request body

provider_modelstring

Legacy combined provider+model field

providerstring

Model provider name

modelstring

Model name

versionstring

Model version identifier

approverinteger nullable

User ID of the assigned approver

security_assessmentboolean

Whether a security assessment has been completed

status'Approved' | 'Restricted' | 'Pending' | 'Blocked' | 'Rejected' | 'Retired'

Current approval/review status of the model

status_datestring date-time

ISO 8601 timestamp for the status

type'Traditional ML' | 'GenAI' | 'RAG' | 'Agentic AI' nullable

Classification of the model AI paradigm (optional)

reference_linkstring

URL to external model documentation

biasesstring

Known biases of the model

limitationsstring

Known limitations of the model

hosting_providerstring

Where the model is hosted

is_demoboolean

Whether this is a demo/sample record

projectsinteger[]

Project IDs to associate. When provided (even empty), replaces all existing project associations.

frameworksinteger[]

Framework IDs to associate. When provided (even empty), replaces all existing framework associations.

deleteProjectsboolean

When true, clears all project associations even if projects array is empty. Used to force-delete associations without providing replacements.

deleteFrameworksboolean

When true, clears all framework associations even if frameworks array is empty. Used to force-delete associations without providing replacements.

Response

Model inventory updated

messagestring

Example response

{
  "message": "OK",
  "data": {
    "id": 42,
    "provider_model": "OpenAI / GPT-4",
    "provider": "OpenAI",
    "model": "GPT-4",
    "version": "turbo-2024-04-09",
    "approver": 7,
    "capabilities": [
      "Text Generation",
      "Code Generation",
      "Reasoning"
    ],
    "status_date": "2026-04-15T10:30:00.000Z",
    "reference_link": "https://platform.openai.com/docs/models/gpt-4",
    "biases": "May reflect biases present in training data",
    "limitations": "Knowledge cutoff, potential hallucinations",
    "hosting_provider": "Azure OpenAI",
    "created_at": "2026-04-10T08:00:00.000Z",
    "updated_at": "2026-04-15T10:30:00.000Z",
    "projects": [
      1,
      3
    ],
    "frameworks": [
      5
    ]
  }
}

Changes

  • a63e59373219Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • 5736e3a0edceRevision changes
    • warning

      added the new Retired enum value to the / response property for the response status

    • info

      added the new Retired enum value to the request property