---
title: "Create Shadow"
method: POST
path: "/gateway/shadows"
tags: ["gateway"]
---

# Create Shadow

`POST /gateway/shadows`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/gateway/shadows`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Request body

- ShadowIn
  - `task_id` string, uuid, required
  - `upstream_id` string, uuid, required
  - `model` string, required
  - `candidate_ref` string, required

## Response `201`

Successful Response

- Shadow
  - `id` string, uuid, required
  - `schema_hash` string, required
  - `upstream_id` string, uuid, nullable, required
  - `model` string, required
  - `candidate_ref` string, required
  - `created_at` string, date-time, required
  - `disabled_at` string, date-time, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/os3robotics/apis/os3-api.md) - [All operations](https://skmtc.dev/os3robotics/apis/os3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/os3robotics/apis/os3-api/revisions/0278b5810d1d?raw)
