Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01703301564.3 KB
Model Inventory

Create a new model inventory

Creates a model inventory record, links it to the supplied project and framework IDs, records a change-history entry, fires any "model_added" automations, and notifies the approver (if set).

post/modelInventory

Request body

provider_modelstring

Legacy combined provider+model field (optional, backward compatibility)

providerstring required

Model provider name

modelstring required

Model name

versionstring required

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' required

Current approval/review status of the model

status_datestring date-time required

ISO 8601 timestamp for the status

reference_linkstring required

URL to external model documentation or model card

biasesstring required

Known biases of the model

limitationsstring required

Known limitations of the model

hosting_providerstring required

Where the model is hosted

is_demoboolean

Whether this is a demo/sample record

projectsinteger[]

Project IDs to associate with this model

frameworksinteger[]

Framework IDs to associate with this model

Example request

{
  "provider_model": "OpenAI / GPT-4",
  "provider": "OpenAI",
  "model": "GPT-4",
  "version": "turbo-2024-04-09",
  "approver": 7,
  "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",
  "projects": [
    1,
    3
  ],
  "frameworks": [
    5
  ]
}

Response

Model inventory created

messagestring

Example response

{
  "message": "Created",
  "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
    ]
  }
}