> 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-1.md).

# Models

## The AoiRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"AoiRequest":{"properties":{"stacItemId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stacitemid"},"stacCollectionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Staccollectionid"},"geometry":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Geometry"}},"type":"object","title":"AoiRequest","description":"Area of interest request.\nParameters:\n    stac_item_id (Optional[int], default=None):\n        ID of an existing AOI STAC item.\n    stac_collection_id (Optional[str], default=None):\n        STAC collection the AOI belongs to.\n    geometry (Optional[list[dict]], default=None):\n        List of GeoJSON geometry objects defining the AOI.\n        Mutually exclusive with STAC identifiers. If provided, a new AOI is created."}}}}
```

## The AoiResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"AoiResponse":{"properties":{"stacItemId":{"type":"integer","title":"Stacitemid"},"stacCollectionId":{"type":"string","title":"Staccollectionid"}},"type":"object","required":["stacItemId","stacCollectionId"],"title":"AoiResponse"}}}}
```

## The Body\_upload\_external\_image\_external\_images\_post object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"Body_upload_external_image_external_images_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_external_image_external_images_post"}}}}
```

## The CategorySummary object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"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"}}}}
```

## The ContextMapResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ContextMapResponse":{"properties":{"gridSize":{"type":"integer","title":"Gridsize"}},"type":"object","required":["gridSize"],"title":"ContextMapResponse"}}}}
```

## The CoverageAoiRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"CoverageAoiRequest":{"properties":{"geometry":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Geometry"}},"type":"object","title":"CoverageAoiRequest","description":"AOI input for the scout-model coverage endpoint.\n\nOnly ``geometry`` is accepted here. The coverage endpoint counts source-imagery\nSTAC items directly via the STAC API (no server-side AOI STAC item is created),\nso the ``stac_item_id`` / ``stac_collection_id`` fields supported by\n:class:`AoiRequest` do not apply and are intentionally omitted."}}}}
```

## The CreateInferenceRunRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"CreateInferenceRunRequest":{"properties":{"modelId":{"type":"integer","title":"Modelid"},"modelVersion":{"type":"integer","title":"Modelversion"},"scoutModelId":{"type":"integer","title":"Scoutmodelid"},"sourceImageryStacItemIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sourceimagerystacitemids"},"toi":{"anyOf":[{"$ref":"#/components/schemas/ToiRequest"},{"type":"null"}]},"aoi":{"anyOf":[{"$ref":"#/components/schemas/AoiRequest"},{"type":"null"}]}},"type":"object","required":["modelId","modelVersion","scoutModelId"],"title":"CreateInferenceRunRequest"},"ToiRequest":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiRequest","description":"Time of Interest request class for handling datetime ranges.\n\n`start` and `end` can be:\n- An ISO 8601 datetime (e.g., \"2018-02-12T00:00:00Z\")\n- None to specify an open interval\n\nArgs:\n    start: The start of the time range (None for open start interval)\n    end: The end of the time range (None for open end interval)\n\nThe string representation of a TOI is \"start/end\", where each part can be an ISO datetime or \"..\" for open intervals when start or end is None.\n\nString Examples:\n- `\"2018-02-12T00:00:00+00:00/2018-03-18T12:31:12+00:00\"`\n- `\"../2018-03-18T12:31:12+00:00\"` if start is None\n- `\"2018-02-12T00:00:00+00:00/..\"` if end is None"},"AoiRequest":{"properties":{"stacItemId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stacitemid"},"stacCollectionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Staccollectionid"},"geometry":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Geometry"}},"type":"object","title":"AoiRequest","description":"Area of interest request.\nParameters:\n    stac_item_id (Optional[int], default=None):\n        ID of an existing AOI STAC item.\n    stac_collection_id (Optional[str], default=None):\n        STAC collection the AOI belongs to.\n    geometry (Optional[list[dict]], default=None):\n        List of GeoJSON geometry objects defining the AOI.\n        Mutually exclusive with STAC identifiers. If provided, a new AOI is created."}}}}
```

## The CreateIngestRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"CreateIngestRequest":{"properties":{"stacIds":{"items":{"type":"string"},"type":"array","title":"Stacids"},"scoutModelRecordId":{"type":"integer","title":"Scoutmodelrecordid"},"scoutModelOverrides":{"anyOf":[{"$ref":"#/components/schemas/ScoutModelOverrides"},{"type":"null"}]},"vectorizerOverrides":{"anyOf":[{"$ref":"#/components/schemas/VectorizerModelOverrides"},{"type":"null"}]},"metadata":{"anyOf":[{},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["stacIds","scoutModelRecordId"],"title":"CreateIngestRequest"},"ScoutModelOverrides":{"properties":{"maxDetects":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxdetects"},"iou":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Iou"},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence"},"batchSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batchsize"},"sliceSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Slicesize"},"sliceOverlapRatio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sliceoverlapratio"},"imageSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Imagesize"},"extraConfig":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Extraconfig"}},"type":"object","title":"ScoutModelOverrides","description":"Override-able fields for scout model configuration. Excludes model identification and path."},"VectorizerModelOverrides":{"properties":{"batchSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batchsize"}},"type":"object","title":"VectorizerModelOverrides","description":"Override-able fields for vectorizer model configuration. Excludes model identification and path."}}}}
```

## The CreateModelRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"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"}}}}
```

## The CreateModelVersionRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"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"}}}}
```

## The CreateTaxonomyCategoryExportRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"CreateTaxonomyCategoryExportRequest":{"properties":{"exportType":{"type":"string","title":"Exporttype","default":"GeoJson"}},"type":"object","title":"CreateTaxonomyCategoryExportRequest"}}}}
```

## The CreateTaxonomyCategoryRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"CreateTaxonomyCategoryRequest":{"properties":{"parentCategoryId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parentcategoryid"},"name":{"type":"string","title":"Name"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["parentCategoryId","name","metadata"],"title":"CreateTaxonomyCategoryRequest"}}}}
```

## The CreateTaxonomyRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"CreateTaxonomyRequest":{"properties":{"name":{"type":"string","title":"Name"},"isReadonly":{"type":"boolean","title":"Isreadonly","default":false},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["name","metadata"],"title":"CreateTaxonomyRequest"}}}}
```

## The EmbeddingSpaceResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"EmbeddingSpaceResponse":{"properties":{"embeddingSpaceId":{"type":"integer","title":"Embeddingspaceid"},"name":{"type":"string","title":"Name"}},"type":"object","required":["embeddingSpaceId","name"],"title":"EmbeddingSpaceResponse"}}}}
```

## The HTTPValidationError object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"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"}}}}
```

## The InferenceRunExportResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"InferenceRunExportResponse":{"properties":{"exportId":{"type":"string","format":"uuid","title":"Exportid"},"inferenceRunId":{"type":"integer","title":"Inferencerunid"},"maxResults":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxresults"},"categoryIds":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Categoryids"},"minConfidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Minconfidence"},"status":{"type":"string","title":"Status"},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Errormessage"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"}},"type":"object","required":["exportId","inferenceRunId","status","createdOn","updatedOn"],"title":"InferenceRunExportResponse"}}}}
```

## The InferenceRunResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"InferenceRunResponse":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"modelId":{"type":"integer","title":"Modelid"},"modelVersion":{"type":"integer","title":"Modelversion"},"scoutModelId":{"type":"integer","title":"Scoutmodelid"},"sourceImageryStacItemIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sourceimagerystacitemids"},"sourceImageryFileName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sourceimageryfilename"},"toi":{"anyOf":[{"$ref":"#/components/schemas/ToiResponse"},{"type":"null"}]},"aoi":{"anyOf":[{"$ref":"#/components/schemas/AoiResponse"},{"type":"null"}]},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"completedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completedon"},"durationSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Durationseconds"},"status":{"type":"string","title":"Status"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["id","modelId","modelVersion","scoutModelId","toi","createdOn","updatedOn","completedOn","durationSeconds","status"],"title":"InferenceRunResponse"},"ToiResponse":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiResponse"},"AoiResponse":{"properties":{"stacItemId":{"type":"integer","title":"Stacitemid"},"stacCollectionId":{"type":"string","title":"Staccollectionid"}},"type":"object","required":["stacItemId","stacCollectionId"],"title":"AoiResponse"}}}}
```

## The InferenceRunResultResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"InferenceRunResultResponse":{"properties":{"metadetectionId":{"type":"string","title":"Metadetectionid"},"predictedTaxonomyCategoryId":{"type":"integer","title":"Predictedtaxonomycategoryid"},"predictedTaxonomyCategoryName":{"type":"string","title":"Predictedtaxonomycategoryname"},"confidence":{"type":"number","title":"Confidence"},"bbox":{"items":{},"type":"array","title":"Bbox"},"cropUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cropurl"}},"type":"object","required":["metadetectionId","predictedTaxonomyCategoryId","predictedTaxonomyCategoryName","confidence","bbox"],"title":"InferenceRunResultResponse"}}}}
```

## The ModelDetailResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"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."}}}}
```

## The ModelInferenceHistory object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ModelInferenceHistory":{"properties":{},"type":"object","title":"ModelInferenceHistory","description":"Placeholder for inference run history summary. Will be populated once inference runs are implemented."}}}}
```

## The ModelResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"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"}}}}
```

## The ModelSummaryResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"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"}}}}
```

## The ModelVersionDetailResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"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"}}}}
```

## The ModelVersionResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"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"}}}}
```

## The PagedResponse\_InferenceRunResponse\_ object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"PagedResponse_InferenceRunResponse_":{"properties":{"total":{"type":"integer","title":"Total"},"pageLength":{"type":"integer","title":"Pagelength"},"pageItems":{"items":{"$ref":"#/components/schemas/InferenceRunResponse"},"type":"array","title":"Pageitems"}},"type":"object","required":["total","pageLength","pageItems"],"title":"PagedResponse[InferenceRunResponse]"},"InferenceRunResponse":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"modelId":{"type":"integer","title":"Modelid"},"modelVersion":{"type":"integer","title":"Modelversion"},"scoutModelId":{"type":"integer","title":"Scoutmodelid"},"sourceImageryStacItemIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sourceimagerystacitemids"},"sourceImageryFileName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sourceimageryfilename"},"toi":{"anyOf":[{"$ref":"#/components/schemas/ToiResponse"},{"type":"null"}]},"aoi":{"anyOf":[{"$ref":"#/components/schemas/AoiResponse"},{"type":"null"}]},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"completedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completedon"},"durationSeconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Durationseconds"},"status":{"type":"string","title":"Status"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["id","modelId","modelVersion","scoutModelId","toi","createdOn","updatedOn","completedOn","durationSeconds","status"],"title":"InferenceRunResponse"},"ToiResponse":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiResponse"},"AoiResponse":{"properties":{"stacItemId":{"type":"integer","title":"Stacitemid"},"stacCollectionId":{"type":"string","title":"Staccollectionid"}},"type":"object","required":["stacItemId","stacCollectionId"],"title":"AoiResponse"}}}}
```

## The PagedResponse\_InferenceRunResultResponse\_ object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"PagedResponse_InferenceRunResultResponse_":{"properties":{"total":{"type":"integer","title":"Total"},"pageLength":{"type":"integer","title":"Pagelength"},"pageItems":{"items":{"$ref":"#/components/schemas/InferenceRunResultResponse"},"type":"array","title":"Pageitems"}},"type":"object","required":["total","pageLength","pageItems"],"title":"PagedResponse[InferenceRunResultResponse]"},"InferenceRunResultResponse":{"properties":{"metadetectionId":{"type":"string","title":"Metadetectionid"},"predictedTaxonomyCategoryId":{"type":"integer","title":"Predictedtaxonomycategoryid"},"predictedTaxonomyCategoryName":{"type":"string","title":"Predictedtaxonomycategoryname"},"confidence":{"type":"number","title":"Confidence"},"bbox":{"items":{},"type":"array","title":"Bbox"},"cropUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cropurl"}},"type":"object","required":["metadetectionId","predictedTaxonomyCategoryId","predictedTaxonomyCategoryName","confidence","bbox"],"title":"InferenceRunResultResponse"}}}}
```

## The PagedResponse\_ModelSummaryResponse\_ object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"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"}}}}
```

## The PagedResponse\_ScoutModelSummaryResponse\_ object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"PagedResponse_ScoutModelSummaryResponse_":{"properties":{"total":{"type":"integer","title":"Total"},"pageLength":{"type":"integer","title":"Pagelength"},"pageItems":{"items":{"$ref":"#/components/schemas/ScoutModelSummaryResponse"},"type":"array","title":"Pageitems"}},"type":"object","required":["total","pageLength","pageItems"],"title":"PagedResponse[ScoutModelSummaryResponse]"},"ScoutModelSummaryResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"}},"type":"object","required":["id","name","createdOn"],"title":"ScoutModelSummaryResponse"}}}}
```

## The QueryImageDetailsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"QueryImageDetailsResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"frameStacId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Framestacid"},"cropBbox":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Cropbbox"},"isExternalImage":{"type":"boolean","title":"Isexternalimage","default":false}},"type":"object","required":["id"],"title":"QueryImageDetailsResponse"}}}}
```

## The QuickStartManifest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"QuickStartManifest":{"properties":{"version":{"type":"integer","title":"Version"},"environment":{"type":"string","title":"Environment"},"scenarios":{"items":{"$ref":"#/components/schemas/QuickStartScenario"},"type":"array","title":"Scenarios"}},"type":"object","required":["version","environment","scenarios"],"title":"QuickStartManifest"},"QuickStartScenario":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"challenge":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Challenge"},"differentiation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Differentiation"},"toi":{"$ref":"#/components/schemas/ScenarioToi"},"aoi":{"$ref":"#/components/schemas/ScenarioAoi"},"detector":{"$ref":"#/components/schemas/ScenarioDetector"},"reference_images":{"items":{"$ref":"#/components/schemas/ScenarioReferenceImage"},"type":"array","title":"Reference Images"}},"type":"object","required":["id","title","description","toi","aoi","detector","reference_images"],"title":"QuickStartScenario"},"ScenarioToi":{"properties":{"start":{"type":"string","title":"Start"},"end":{"type":"string","title":"End"}},"type":"object","required":["start","end"],"title":"ScenarioToi"},"ScenarioAoi":{"properties":{"name":{"type":"string","title":"Name"},"geometry":{"items":{"$ref":"#/components/schemas/ScenarioAoiGeometry"},"type":"array","title":"Geometry"}},"type":"object","required":["name","geometry"],"title":"ScenarioAoi"},"ScenarioAoiGeometry":{"properties":{"type":{"type":"string","const":"Polygon","title":"Type"},"coordinates":{"items":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},"type":"array","title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"ScenarioAoiGeometry"},"ScenarioDetector":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"ScenarioDetector"},"ScenarioReferenceImage":{"properties":{"metadetection_id":{"type":"string","title":"Metadetection Id"},"label":{"type":"string","title":"Label"}},"type":"object","required":["metadetection_id","label"],"title":"ScenarioReferenceImage"}}}}
```

## The QuickStartScenario object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"QuickStartScenario":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"challenge":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Challenge"},"differentiation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Differentiation"},"toi":{"$ref":"#/components/schemas/ScenarioToi"},"aoi":{"$ref":"#/components/schemas/ScenarioAoi"},"detector":{"$ref":"#/components/schemas/ScenarioDetector"},"reference_images":{"items":{"$ref":"#/components/schemas/ScenarioReferenceImage"},"type":"array","title":"Reference Images"}},"type":"object","required":["id","title","description","toi","aoi","detector","reference_images"],"title":"QuickStartScenario"},"ScenarioToi":{"properties":{"start":{"type":"string","title":"Start"},"end":{"type":"string","title":"End"}},"type":"object","required":["start","end"],"title":"ScenarioToi"},"ScenarioAoi":{"properties":{"name":{"type":"string","title":"Name"},"geometry":{"items":{"$ref":"#/components/schemas/ScenarioAoiGeometry"},"type":"array","title":"Geometry"}},"type":"object","required":["name","geometry"],"title":"ScenarioAoi"},"ScenarioAoiGeometry":{"properties":{"type":{"type":"string","const":"Polygon","title":"Type"},"coordinates":{"items":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},"type":"array","title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"ScenarioAoiGeometry"},"ScenarioDetector":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"ScenarioDetector"},"ScenarioReferenceImage":{"properties":{"metadetection_id":{"type":"string","title":"Metadetection Id"},"label":{"type":"string","title":"Label"}},"type":"object","required":["metadetection_id","label"],"title":"ScenarioReferenceImage"}}}}
```

## The ScenarioAoi object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScenarioAoi":{"properties":{"name":{"type":"string","title":"Name"},"geometry":{"items":{"$ref":"#/components/schemas/ScenarioAoiGeometry"},"type":"array","title":"Geometry"}},"type":"object","required":["name","geometry"],"title":"ScenarioAoi"},"ScenarioAoiGeometry":{"properties":{"type":{"type":"string","const":"Polygon","title":"Type"},"coordinates":{"items":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},"type":"array","title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"ScenarioAoiGeometry"}}}}
```

## The ScenarioAoiGeometry object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScenarioAoiGeometry":{"properties":{"type":{"type":"string","const":"Polygon","title":"Type"},"coordinates":{"items":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},"type":"array","title":"Coordinates"}},"type":"object","required":["type","coordinates"],"title":"ScenarioAoiGeometry"}}}}
```

## The ScenarioDetector object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScenarioDetector":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"ScenarioDetector"}}}}
```

## The ScenarioReferenceImage object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScenarioReferenceImage":{"properties":{"metadetection_id":{"type":"string","title":"Metadetection Id"},"label":{"type":"string","title":"Label"}},"type":"object","required":["metadetection_id","label"],"title":"ScenarioReferenceImage"}}}}
```

## The ScenarioToi object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScenarioToi":{"properties":{"start":{"type":"string","title":"Start"},"end":{"type":"string","title":"End"}},"type":"object","required":["start","end"],"title":"ScenarioToi"}}}}
```

## The ScoutModelCoverageResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScoutModelCoverageResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"sceneCount":{"type":"integer","title":"Scenecount"}},"type":"object","required":["id","name","createdOn","sceneCount"],"title":"ScoutModelCoverageResponse","description":"A scout model plus coverage statistics inside the requested TOI/AOI."}}}}
```

## The ScoutModelOverrides object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScoutModelOverrides":{"properties":{"maxDetects":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxdetects"},"iou":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Iou"},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence"},"batchSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batchsize"},"sliceSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Slicesize"},"sliceOverlapRatio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sliceoverlapratio"},"imageSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Imagesize"},"extraConfig":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Extraconfig"}},"type":"object","title":"ScoutModelOverrides","description":"Override-able fields for scout model configuration. Excludes model identification and path."}}}}
```

## The ScoutModelSummaryResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScoutModelSummaryResponse":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"}},"type":"object","required":["id","name","createdOn"],"title":"ScoutModelSummaryResponse"}}}}
```

## The ScoutModelsCoverageRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ScoutModelsCoverageRequest":{"properties":{"toi":{"anyOf":[{"$ref":"#/components/schemas/ToiRequest"},{"type":"null"}]},"aoi":{"anyOf":[{"$ref":"#/components/schemas/CoverageAoiRequest"},{"type":"null"}]}},"type":"object","title":"ScoutModelsCoverageRequest","description":"Request body for the scout-model coverage endpoint.\n\nBoth ``toi`` and ``aoi`` are optional. When ``toi`` is provided,\n``toi.start`` / ``toi.end`` are still individually optional; when both are\nprovided, ``end`` must be ≥ ``start``. When ``aoi`` is omitted, coverage\nis computed across all space."},"ToiRequest":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiRequest","description":"Time of Interest request class for handling datetime ranges.\n\n`start` and `end` can be:\n- An ISO 8601 datetime (e.g., \"2018-02-12T00:00:00Z\")\n- None to specify an open interval\n\nArgs:\n    start: The start of the time range (None for open start interval)\n    end: The end of the time range (None for open end interval)\n\nThe string representation of a TOI is \"start/end\", where each part can be an ISO datetime or \"..\" for open intervals when start or end is None.\n\nString Examples:\n- `\"2018-02-12T00:00:00+00:00/2018-03-18T12:31:12+00:00\"`\n- `\"../2018-03-18T12:31:12+00:00\"` if start is None\n- `\"2018-02-12T00:00:00+00:00/..\"` if end is None"},"CoverageAoiRequest":{"properties":{"geometry":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Geometry"}},"type":"object","title":"CoverageAoiRequest","description":"AOI input for the scout-model coverage endpoint.\n\nOnly ``geometry`` is accepted here. The coverage endpoint counts source-imagery\nSTAC items directly via the STAC API (no server-side AOI STAC item is created),\nso the ``stac_item_id`` / ``stac_collection_id`` fields supported by\n:class:`AoiRequest` do not apply and are intentionally omitted."}}}}
```

## The SearchRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"SearchRequest":{"properties":{"metadetectionIds":{"items":{"type":"string"},"type":"array","title":"Metadetectionids","default":[]},"toi":{"anyOf":[{"$ref":"#/components/schemas/ToiRequest"},{"type":"null"}]},"aoi":{"anyOf":[{"$ref":"#/components/schemas/AoiRequest"},{"type":"null"}]},"taxonomyCategoryIds":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Taxonomycategoryids"},"includeTaxonomyCategoryItems":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Includetaxonomycategoryitems","default":false},"targetWidthMeters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Targetwidthmeters"},"targetLengthMeters":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Targetlengthmeters"},"scoutModelId":{"type":"integer","title":"Scoutmodelid"}},"type":"object","required":["scoutModelId"],"title":"SearchRequest","description":"SearchRequest model for starting a new search.\nParameters:\n    metadetection_ids (list[str], default=[]):\n        List of metadetection ids used as the reference embedding to search for similar embeddings.\n    toi (Optional[ToiRequest], default=None):\n        An optional time-of-interest object that defines the search time interval.\n    aoi (Optional[AoiRequest], default=None):\n        An optional area-of-interest object. Provide geometry (list of GeoJSON dicts) to filter\n        results spatially, or provide stac_item_id and stac_collection_id to use an existing AOI (NotImplementedYet).\n    include_taxonomy_category_items (Optional[bool], default=False):\n        When False (default), search results exclude items already categorized in taxonomy.\n        When True, search results include all items regardless of taxonomy categorization."},"ToiRequest":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiRequest","description":"Time of Interest request class for handling datetime ranges.\n\n`start` and `end` can be:\n- An ISO 8601 datetime (e.g., \"2018-02-12T00:00:00Z\")\n- None to specify an open interval\n\nArgs:\n    start: The start of the time range (None for open start interval)\n    end: The end of the time range (None for open end interval)\n\nThe string representation of a TOI is \"start/end\", where each part can be an ISO datetime or \"..\" for open intervals when start or end is None.\n\nString Examples:\n- `\"2018-02-12T00:00:00+00:00/2018-03-18T12:31:12+00:00\"`\n- `\"../2018-03-18T12:31:12+00:00\"` if start is None\n- `\"2018-02-12T00:00:00+00:00/..\"` if end is None"},"AoiRequest":{"properties":{"stacItemId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stacitemid"},"stacCollectionId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Staccollectionid"},"geometry":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Geometry"}},"type":"object","title":"AoiRequest","description":"Area of interest request.\nParameters:\n    stac_item_id (Optional[int], default=None):\n        ID of an existing AOI STAC item.\n    stac_collection_id (Optional[str], default=None):\n        STAC collection the AOI belongs to.\n    geometry (Optional[list[dict]], default=None):\n        List of GeoJSON geometry objects defining the AOI.\n        Mutually exclusive with STAC identifiers. If provided, a new AOI is created."}}}}
```

## The SearchResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"SearchResponse":{"properties":{"searchId":{"type":"integer","title":"Searchid"},"status":{"type":"string","title":"Status"},"completedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completedon"},"durationMs":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Durationms"},"tiffsSearched":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tiffssearched"},"toi":{"anyOf":[{"$ref":"#/components/schemas/ToiResponse"},{"type":"null"}]},"aoi":{"anyOf":[{"$ref":"#/components/schemas/AoiResponse"},{"type":"null"}]},"queryImageDetails":{"anyOf":[{"items":{"$ref":"#/components/schemas/QueryImageDetailsResponse"},"type":"array"},{"type":"null"}],"title":"Queryimagedetails"},"scoutModelName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scoutmodelname"},"isPinned":{"type":"boolean","title":"Ispinned","default":false},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["searchId","status"],"title":"SearchResponse"},"ToiResponse":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiResponse"},"AoiResponse":{"properties":{"stacItemId":{"type":"integer","title":"Stacitemid"},"stacCollectionId":{"type":"string","title":"Staccollectionid"}},"type":"object","required":["stacItemId","stacCollectionId"],"title":"AoiResponse"},"QueryImageDetailsResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"frameStacId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Framestacid"},"cropBbox":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Cropbbox"},"isExternalImage":{"type":"boolean","title":"Isexternalimage","default":false}},"type":"object","required":["id"],"title":"QueryImageDetailsResponse"}}}}
```

## The SearchResponseDetails object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"SearchResponseDetails":{"properties":{"searchId":{"type":"integer","title":"Searchid"},"status":{"type":"string","title":"Status"},"completedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completedon"},"durationMs":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Durationms"},"tiffsSearched":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tiffssearched"},"toi":{"anyOf":[{"$ref":"#/components/schemas/ToiResponse"},{"type":"null"}]},"aoi":{"anyOf":[{"$ref":"#/components/schemas/AoiResponse"},{"type":"null"}]},"queryImageDetails":{"anyOf":[{"items":{"$ref":"#/components/schemas/QueryImageDetailsResponse"},"type":"array"},{"type":"null"}],"title":"Queryimagedetails"},"scoutModelName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scoutmodelname"},"isPinned":{"type":"boolean","title":"Ispinned","default":false},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"results":{"anyOf":[{"items":{"$ref":"#/components/schemas/SearchResultResponse"},"type":"array"},{"type":"null"}],"title":"Results"},"contextMap":{"anyOf":[{"$ref":"#/components/schemas/ContextMapResponse"},{"type":"null"}]}},"type":"object","required":["searchId","status"],"title":"SearchResponseDetails"},"ToiResponse":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiResponse"},"AoiResponse":{"properties":{"stacItemId":{"type":"integer","title":"Stacitemid"},"stacCollectionId":{"type":"string","title":"Staccollectionid"}},"type":"object","required":["stacItemId","stacCollectionId"],"title":"AoiResponse"},"QueryImageDetailsResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"frameStacId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Framestacid"},"cropBbox":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Cropbbox"},"isExternalImage":{"type":"boolean","title":"Isexternalimage","default":false}},"type":"object","required":["id"],"title":"QueryImageDetailsResponse"},"SearchResultResponse":{"properties":{"metadetectionId":{"type":"string","title":"Metadetectionid"},"frameStacId":{"type":"string","title":"Framestacid"},"acquiredOn":{"type":"string","format":"date-time","title":"Acquiredon"},"bbox":{"items":{"type":"number"},"type":"array","title":"Bbox"},"geometry":{"anyOf":[{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},{"type":"null"}],"title":"Geometry"},"nativeCrs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nativecrs"},"nativeCrsBbox":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Nativecrsbbox"},"score":{"type":"number","title":"Score","default":0},"contextMapX":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Contextmapx"},"contextMapY":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Contextmapy"}},"type":"object","required":["metadetectionId","frameStacId","acquiredOn","bbox"],"title":"SearchResultResponse"},"ContextMapResponse":{"properties":{"gridSize":{"type":"integer","title":"Gridsize"}},"type":"object","required":["gridSize"],"title":"ContextMapResponse"}}}}
```

## The SearchResultResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"SearchResultResponse":{"properties":{"metadetectionId":{"type":"string","title":"Metadetectionid"},"frameStacId":{"type":"string","title":"Framestacid"},"acquiredOn":{"type":"string","format":"date-time","title":"Acquiredon"},"bbox":{"items":{"type":"number"},"type":"array","title":"Bbox"},"geometry":{"anyOf":[{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},{"type":"null"}],"title":"Geometry"},"nativeCrs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nativecrs"},"nativeCrsBbox":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Nativecrsbbox"},"score":{"type":"number","title":"Score","default":0},"contextMapX":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Contextmapx"},"contextMapY":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Contextmapy"}},"type":"object","required":["metadetectionId","frameStacId","acquiredOn","bbox"],"title":"SearchResultResponse"}}}}
```

## The SortDirection object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"SortDirection":{"type":"string","enum":["asc","desc"],"title":"SortDirection"}}}}
```

## The SortableColumns object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"SortableColumns":{"type":"string","enum":["created_on","version_created_on","last_run_at"],"title":"SortableColumns"}}}}
```

## The TaxonomyCategoryExportResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"TaxonomyCategoryExportResponse":{"properties":{"exportId":{"type":"string","format":"uuid","title":"Exportid"},"taxonomyCategoryId":{"type":"integer","title":"Taxonomycategoryid"},"exportType":{"type":"string","title":"Exporttype"},"status":{"type":"string","title":"Status"},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Errormessage"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"}},"type":"object","required":["exportId","taxonomyCategoryId","exportType","status","createdOn","updatedOn"],"title":"TaxonomyCategoryExportResponse"}}}}
```

## The ToiRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ToiRequest":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiRequest","description":"Time of Interest request class for handling datetime ranges.\n\n`start` and `end` can be:\n- An ISO 8601 datetime (e.g., \"2018-02-12T00:00:00Z\")\n- None to specify an open interval\n\nArgs:\n    start: The start of the time range (None for open start interval)\n    end: The end of the time range (None for open end interval)\n\nThe string representation of a TOI is \"start/end\", where each part can be an ISO datetime or \"..\" for open intervals when start or end is None.\n\nString Examples:\n- `\"2018-02-12T00:00:00+00:00/2018-03-18T12:31:12+00:00\"`\n- `\"../2018-03-18T12:31:12+00:00\"` if start is None\n- `\"2018-02-12T00:00:00+00:00/..\"` if end is None"}}}}
```

## The ToiResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"ToiResponse":{"properties":{"start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start"},"end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End"}},"type":"object","title":"ToiResponse"}}}}
```

## The UpdateSearchRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"UpdateSearchRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"isPinned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ispinned"}},"type":"object","title":"UpdateSearchRequest"}}}}
```

## The UpdateTaxonomyCategoryItemRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"UpdateTaxonomyCategoryItemRequest":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"isApproved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isapproved"}},"type":"object","required":["id","isApproved"],"title":"UpdateTaxonomyCategoryItemRequest"}}}}
```

## The UpdateTaxonomyCategoryRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"UpdateTaxonomyCategoryRequest":{"properties":{"parentCategoryId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parentcategoryid"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["parentCategoryId","name","metadata"],"title":"UpdateTaxonomyCategoryRequest"}}}}
```

## The UpdateUserRequest object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"UpdateUserRequest":{"properties":{"hasSeenQuickStart":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasseenquickstart"}},"type":"object","title":"UpdateUserRequest"}}}}
```

## The UserResponse object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"UserResponse":{"properties":{"userId":{"type":"string","title":"Userid"},"createdOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdon"},"updatedOn":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedon"},"hasSeenQuickStart":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasseenquickstart"}},"type":"object","required":["userId"],"title":"UserResponse"}}}}
```

## The ValidationError object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"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"}}}}
```

## The VectorizerModelOverrides object

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"components":{"schemas":{"VectorizerModelOverrides":{"properties":{"batchSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batchsize"}},"type":"object","title":"VectorizerModelOverrides","description":"Override-able fields for vectorizer model configuration. Excludes model identification and path."}}}}
```