> For the complete documentation index, see [llms.txt](https://raic-labs.gitbook.io/raic-fed/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://raic-labs.gitbook.io/raic-fed/api-reference/04a-foundry-api/models.md).

# Models

## Get Models

> Get a paginated list of models with their latest version details.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/models":{"get":{"tags":["models"],"summary":"Get Models","description":"Get a paginated list of models with their latest version details.","operationId":"get_models_models_get","parameters":[{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortableColumns","description":"Column to sort by","default":"created_on"},"description":"Column to sort by"},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortDirection","default":"desc"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"The number of results to skip","default":0,"title":"Skip"},"description":"The number of results to skip"},{"name":"top","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"The number of results to return","default":25,"title":"Top"},"description":"The number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponse_ModelSummaryResponse_"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"SortableColumns":{"type":"string","enum":["created_on","version_created_on","last_run_at"],"title":"SortableColumns"},"SortDirection":{"type":"string","enum":["asc","desc"],"title":"SortDirection"},"PagedResponse_ModelSummaryResponse_":{"properties":{"total":{"type":"integer","title":"Total"},"pageLength":{"type":"integer","title":"Pagelength"},"pageItems":{"items":{"$ref":"#/components/schemas/ModelSummaryResponse"},"type":"array","title":"Pageitems"}},"type":"object","required":["total","pageLength","pageItems"],"title":"PagedResponse[ModelSummaryResponse]"},"ModelSummaryResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"versionNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Versionnumber"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"versionCreatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Versioncreatedon"},"lastRunAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Lastrunat"},"categories":{"items":{"$ref":"#/components/schemas/CategorySummary"},"type":"array","title":"Categories"},"hyperparameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hyperparameters"}},"type":"object","required":["id","name","status","versionNumber","createdOn","versionCreatedOn","lastRunAt","categories","hyperparameters"],"title":"ModelSummaryResponse"},"CategorySummary":{"properties":{"recordId":{"type":"integer","title":"Recordid"},"name":{"type":"string","title":"Name"},"totalItems":{"type":"integer","title":"Totalitems"},"approvedItemCount":{"type":"integer","title":"Approveditemcount"}},"type":"object","required":["recordId","name","totalItems","approvedItemCount"],"title":"CategorySummary"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Create Model

> Create a new model and its first version.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/models":{"post":{"tags":["models"],"summary":"Create Model","description":"Create a new model and its first version.","operationId":"create_model_models_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModelRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CreateModelRequest":{"properties":{"taxonomyCategoryIds":{"items":{"type":"integer"},"type":"array","title":"Taxonomycategoryids"},"hyperparameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hyperparameters"},"name":{"type":"string","title":"Name"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["taxonomyCategoryIds","name"],"title":"CreateModelRequest"},"ModelResponse":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"name":{"type":"string","title":"Name"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["id","name","createdOn","updatedOn","metadata"],"title":"ModelResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Model Detail

> Get detailed information for a model by ID, including all versions and their taxonomy categories.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/models/{model_id}":{"get":{"tags":["models"],"summary":"Get Model Detail","description":"Get detailed information for a model by ID, including all versions and their taxonomy categories.","operationId":"get_model_detail_models__model_id__get","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelDetailResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ModelDetailResponse":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"name":{"type":"string","title":"Name"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"versions":{"items":{"$ref":"#/components/schemas/ModelVersionDetailResponse"},"type":"array","title":"Versions"},"inferenceHistory":{"anyOf":[{"items":{"$ref":"#/components/schemas/ModelInferenceHistory"},"type":"array"},{"type":"null"}],"title":"Inferencehistory"}},"type":"object","required":["id","name","createdOn","updatedOn","metadata","versions","inferenceHistory"],"title":"ModelDetailResponse"},"ModelVersionDetailResponse":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"modelId":{"type":"integer","title":"Modelid"},"versionNumber":{"type":"integer","title":"Versionnumber"},"taxonomyId":{"type":"integer","title":"Taxonomyid"},"status":{"type":"string","title":"Status"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"hyperparameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hyperparameters"},"categories":{"items":{"$ref":"#/components/schemas/CategorySummary"},"type":"array","title":"Categories"}},"type":"object","required":["id","modelId","versionNumber","taxonomyId","status","createdOn","updatedOn","hyperparameters","categories"],"title":"ModelVersionDetailResponse"},"CategorySummary":{"properties":{"recordId":{"type":"integer","title":"Recordid"},"name":{"type":"string","title":"Name"},"totalItems":{"type":"integer","title":"Totalitems"},"approvedItemCount":{"type":"integer","title":"Approveditemcount"}},"type":"object","required":["recordId","name","totalItems","approvedItemCount"],"title":"CategorySummary"},"ModelInferenceHistory":{"properties":{},"type":"object","title":"ModelInferenceHistory","description":"Placeholder for inference run history summary. Will be populated once inference runs are implemented."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Delete Model

> Archive a model and all its versions.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/models/{model_id}":{"delete":{"tags":["models"],"summary":"Delete Model","description":"Archive a model and all its versions.","operationId":"delete_model_models__model_id__delete","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Create Model Version

> Create a new model version.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/models/{model_id}/versions":{"post":{"tags":["models"],"summary":"Create Model Version","description":"Create a new model version.","operationId":"create_model_version_models__model_id__versions_post","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModelVersionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelVersionResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CreateModelVersionRequest":{"properties":{"taxonomyCategoryIds":{"items":{"type":"integer"},"type":"array","title":"Taxonomycategoryids"},"hyperparameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hyperparameters"}},"type":"object","required":["taxonomyCategoryIds"],"title":"CreateModelVersionRequest"},"ModelVersionResponse":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"modelId":{"type":"integer","title":"Modelid"},"versionNumber":{"type":"integer","title":"Versionnumber"},"taxonomyId":{"type":"integer","title":"Taxonomyid"},"status":{"type":"string","title":"Status"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"hyperparameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hyperparameters"}},"type":"object","required":["id","modelId","versionNumber","taxonomyId","status","createdOn","updatedOn","hyperparameters"],"title":"ModelVersionResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Model Version Detail

> Get detailed information for a specific model version, including its taxonomy categories.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/models/{model_id}/versions/{version_number}":{"get":{"tags":["models"],"summary":"Get Model Version Detail","description":"Get detailed information for a specific model version, including its taxonomy categories.","operationId":"get_model_version_detail_models__model_id__versions__version_number__get","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}},{"name":"version_number","in":"path","required":true,"schema":{"type":"integer","title":"Version Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelVersionDetailResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ModelVersionDetailResponse":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"modelId":{"type":"integer","title":"Modelid"},"versionNumber":{"type":"integer","title":"Versionnumber"},"taxonomyId":{"type":"integer","title":"Taxonomyid"},"status":{"type":"string","title":"Status"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"hyperparameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hyperparameters"},"categories":{"items":{"$ref":"#/components/schemas/CategorySummary"},"type":"array","title":"Categories"}},"type":"object","required":["id","modelId","versionNumber","taxonomyId","status","createdOn","updatedOn","hyperparameters","categories"],"title":"ModelVersionDetailResponse"},"CategorySummary":{"properties":{"recordId":{"type":"integer","title":"Recordid"},"name":{"type":"string","title":"Name"},"totalItems":{"type":"integer","title":"Totalitems"},"approvedItemCount":{"type":"integer","title":"Approveditemcount"}},"type":"object","required":["recordId","name","totalItems","approvedItemCount"],"title":"CategorySummary"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Start Model Version Training

> Start training for a specific model version.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/models/{model_id}/versions/{version_number}/train":{"post":{"tags":["models"],"summary":"Start Model Version Training","description":"Start training for a specific model version.","operationId":"start_model_version_training_models__model_id__versions__version_number__train_post","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}},{"name":"version_number","in":"path","required":true,"schema":{"type":"integer","title":"Version Number"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelVersionResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ModelVersionResponse":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"modelId":{"type":"integer","title":"Modelid"},"versionNumber":{"type":"integer","title":"Versionnumber"},"taxonomyId":{"type":"integer","title":"Taxonomyid"},"status":{"type":"string","title":"Status"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"hyperparameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Hyperparameters"}},"type":"object","required":["id","modelId","versionNumber","taxonomyId","status","createdOn","updatedOn","hyperparameters"],"title":"ModelVersionResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```