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

# Quick Start

## Get Scenarios

> Return the Quick Start scenarios manifest.\
> Returns a default empty manifest if no scenarios have been configured for this environment.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/quick-start/scenarios":{"get":{"tags":["quick-start"],"summary":"Get Scenarios","description":"Return the Quick Start scenarios manifest.\nReturns a default empty manifest if no scenarios have been configured for this environment.","operationId":"get_scenarios_quick_start_scenarios_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickStartManifest"}}}}}}}},"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"}}}}
```

## Put Scenarios

> Create or replace the Quick Start scenarios manifest.

```json
{"openapi":"3.1.0","info":{"title":"Foundry Api","version":"0.1.0"},"servers":[{"url":"/foundry"}],"paths":{"/quick-start/scenarios":{"put":{"tags":["quick-start"],"summary":"Put Scenarios","description":"Create or replace the Quick Start scenarios manifest.","operationId":"put_scenarios_quick_start_scenarios_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickStartManifest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickStartManifest"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"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"},"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"}}}}
```