Introduction to the API reference documentation
https://api.runa.io/v2
https://playground.runa.io/v2
X-Api-Key
header of each request.
wg
whereas playground keys start with xx
.
Once you’re ready to start using production your should refer to the security best practices guide to ensure you’re using and storing your keys securely.
The status code dropdown in the response section switches between the different response types.
POST /v2/order
response returns a different structure for the
200 OK
and 202 Accepted
status codes. The 200 OK
response returns the
whole order object, while the 202 Accepted
response returns a minimal object
containing only the order ID and status when using the async
ordering mode.
Error status code starting 4xx
and 5xx
have a consistent error response structure. See the guide on handling errors for more information and best practices on how to handle errors.