Skip to main content
GET
/
{runchat_id}
/
schema
Get Runchat Schema
curl --request GET \
  --url https://runchat.com/api/v1/{runchat_id}/schema \
  --header 'Authorization: Bearer <token>'
{
  "inputs": [
    {
      "id": "<string>",
      "label": "<string>",
      "description": "<string>",
      "data": [
        {}
      ]
    }
  ],
  "outputs": [
    {
      "id": "<string>",
      "label": "<string>",
      "description": "<string>",
      "data": [
        {}
      ]
    }
  ],
  "name": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using Runchat API key. API keys can be created from the account menu

Path Parameters

​
runchat_id
string
required

The unique identifier for the Runchat. The Runchat ID can be found in the id parameter of the URL when open in the editor.

Response

Successful retrieval of the Runchat schema.

​
inputs
object[]

Array of input parameters defined in the Runchat API.

​
outputs
object[]

Array of output parameters defined in the Runchat API.

​
name
string

The name of the Runchat flow.