---
title: "Get Runchat Schema"
method: GET
path: "/{runchat_id}/schema"
tags: ["Schema"]
---

# Get Runchat Schema

`GET /{runchat_id}/schema`

Retrieves the defined API input and output parameters for a specific Runchat flow.

## Response `200`

Successful retrieval of the Runchat schema.

- object
  - `inputs` BasicParameter[] — Array of input parameters defined in the Runchat API.
    - `id` string, required — Unique identifier for the parameter, often in the format 'paramKey_parentNodeId'.
    - `label` string, required — User-friendly label for the parameter.
    - `type` 'string' | 'number' | 'boolean' | 'object' | 'image' | 'video' | 'audio' | 'model' | 'message' | 'context' | 'code' | 'array' | 'instruction' | 'null' | 'markdown' | 'file' | 'format' | 'html' | 'pdf' | 'trigger' | 'select', required — Enumeration of supported data types within Runchat.
    - `description` string, required — Description of the parameter.
    - `data` object[], required — The actual data associated with the parameter, represented as an array of items.
  - `outputs` BasicParameter[] — Array of output parameters defined in the Runchat API.
    - `id` string, required — Unique identifier for the parameter, often in the format 'paramKey_parentNodeId'.
    - `label` string, required — User-friendly label for the parameter.
    - `type` 'string' | 'number' | 'boolean' | 'object' | 'image' | 'video' | 'audio' | 'model' | 'message' | 'context' | 'code' | 'array' | 'instruction' | 'null' | 'markdown' | 'file' | 'format' | 'html' | 'pdf' | 'trigger' | 'select', required — Enumeration of supported data types within Runchat.
    - `description` string, required — Description of the parameter.
    - `data` object[], required — The actual data associated with the parameter, represented as an array of items.
  - `name` string — The name of the Runchat flow.

## Other responses

- `400` — Bad Request - The request could not be understood or was missing required parameters.
- `500` — Internal Server Error - An unexpected error occurred on the server.

---

[API](https://skmtc.dev/runchat/apis/runchat-api.md) · [All operations](https://skmtc.dev/runchat/apis/runchat-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runchat/runchat-api/revisions/ccf82c335a7e/schema)