> 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/ingest.md).

# Ingest

## GET /ingests/files

> Get Ingest Files

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/ingests/files":{"get":{"tags":["ingest"],"summary":"Get Ingest Files","operationId":"get_ingest_files_ingests_files_get","parameters":[{"name":"file_path","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path"}},{"name":"scout_model_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scout Model Id"}},{"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":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"SortDirection":{"type":"string","enum":["asc","desc"],"title":"SortDirection"},"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 /ingests

> Get All

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/ingests":{"get":{"tags":["ingest"],"summary":"Get All","operationId":"get_all_ingests_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"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":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"SortDirection":{"type":"string","enum":["asc","desc"],"title":"SortDirection"},"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"}}}}
```

## POST /ingests

> Create

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/ingests":{"post":{"tags":["ingest"],"summary":"Create","operationId":"create_ingests_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIngestRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"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."},"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 /ingests/{ingest\_id}

> Get

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/ingests/{ingest_id}":{"get":{"tags":["ingest"],"summary":"Get","operationId":"get_ingests__ingest_id__get","parameters":[{"name":"ingest_id","in":"path","required":true,"schema":{"type":"string","title":"Ingest Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"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"}}}}
```

## POST /ingests/{ingest\_id}

> Start

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/ingests/{ingest_id}":{"post":{"tags":["ingest"],"summary":"Start","operationId":"start_ingests__ingest_id__post","parameters":[{"name":"ingest_id","in":"path","required":true,"schema":{"type":"string","title":"Ingest Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"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"}}}}
```

## DELETE /ingests/{ingest\_id}

> Cancel

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/ingests/{ingest_id}":{"delete":{"tags":["ingest"],"summary":"Cancel","operationId":"cancel_ingests__ingest_id__delete","parameters":[{"name":"ingest_id","in":"path","required":true,"schema":{"type":"string","title":"Ingest Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"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"}}}}
```