RUNNING
API reference
Every service you can call, from the OpenAPI document the build reads. A page here cannot name a call or a field that is not in that document.
Published services
| Service | Tier | Notice before a change | Calls |
|---|---|---|---|
| RunService | beta | At least 90 days | 23 calls, 10 released and 13 not released yet; 12 may also be sent as a GET |
Everything else the console calls is internal: it is not documented, it is not in the OpenAPI document, and nothing about its shape is promised.
The OpenAPI document
openapi.yaml is the same description as a file, for a generator or a linter of your own. It names
only what is published, as plain HTTP: each call is a POST of JSON, and a call that only reads has a GET form as
well.
What a tier promises
Stable is built to be depended on, and a change to it is announced at least 12 months before it takes effect. Beta is complete enough to use and still settling, and a change to it is announced at least 90 days before. How the API changes says how the notice is given.