Skip to main content
The API is used by integrations like our Rhino and Grasshopper plugin.

​
Quickstart

To schedule a run without providing input data you can use the GET method on the Run endpoint. If the Runchat contains a webhook node, the entire JSON body of a POST request to the Run endpoint will be set as the input to that node. This allows you to trigger runchats without first defining a specific input schema. To assign data to specific input parameters, first use the Schema endpoint to retrieve an array of published parameter IDs. You can then map over input parameter IDs to create the required inputs array for the Run endpoint.

​
Authentication

The Runchat API uses keys to authenticate requests to the API on behalf of your runchat user profile and account. Runchat API keys can only be used to authenticate requests to endpoints, and cannot be used to download or access any information about your user profile or account. However, we still recommend you keep these keys secure and cycle them frequently. To create an API key head to https://runchat.app/dashboard and click on your account button in the left side drawer. Then click “Get Runchat API Key”. Scroll to the bottom of the page to the Runchat API Keys section and click Create New Key. Copy the generated key and store it somewhere securely. All API endpoints are authenticated using the Authorization header and a Bearer token. 
"Authorization": `Bearer ${YOUR_API_KEY}`

​
Rate limits

Requests to the API are limited to 10 requests per minute. If you need higher rate limits please contact support.