---
title: "Get Protocol Schema"
method: GET
path: "/discovery/schemas/protocol"
tags: ["discovery"]
---

# Get Protocol Schema

`GET /discovery/schemas/protocol`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/discovery/schemas/protocol`
- Auth: none declared

Return the Universal Cycler Protocol (UCP) authoring guide.

Describes the YAML input format (single-key dicts keyed by step
type), the supported step and end-condition forms, runnable
example protocols, and a machine-checkable JSON Schema
(``input_schema``) for the authoring format. The JSON Schema is
generated from the same enums the parser uses and is parity-tested
against ``validate_protocol_from_dict``.

## Response `200`

Successful Response

- unknown

---

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