---
title: "Annotate Episode"
method: POST
path: "/datasets/{dataset_id}/versions/{version}/episodes/{episode_index}/annotations"
tags: ["review"]
---

# Annotate Episode

`POST /datasets/{dataset_id}/versions/{version}/episodes/{episode_index}/annotations`

## 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/datasets/{dataset_id}/versions/{version}/episodes/{episode_index}/annotations`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `dataset_id` string, uuid, required
- `version` integer, required
- `episode_index` integer, required

## Request body

- union
  - SubtasksIn
    - `kind` 'subtasks', required
    - `subtasks` Subtask[], required
      - `name` string, required
      - `start` integer, required
      - `end` integer, required
    - `note` string, nullable
  - FailureTagsIn
    - `kind` 'failure_tags', required
    - `tags` string[], required
    - `note` string, nullable

## Response `201`

Successful Response

- Annotation
  - `id` integer, required
  - `kind` string, required
  - `revision` integer, required
  - `body` unknown[], required
    - unknown
  - `note` string, nullable, required
  - `actor_kind` string, required
  - `actor_id` string, required
  - `actor_name` string, nullable, required
  - `created_at` string, date-time, 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/af32cd4f14bb?raw)