API Reference

The RunReveal API is a REST API served from:

https://api.runreveal.com

The pages in this section are generated from the API's OpenAPI specification and document every endpoint, including request parameters, body schemas, and response shapes. Endpoints are grouped by resource in the sidebar.

Authentication

Most endpoints require an API token. Create one at https://app.runreveal.com/dash/workspace/settings#api-tokens and pass it as the token in a Basic auth header:

curl -H 'Authorization: Basic <token>' 'https://api.runreveal.com/sources/'

The token is scoped to the workspace it was created in, so the workspace is determined automatically — no workspaceid parameter is needed.

Responses

Successful responses are JSON envelopes with a success flag and the endpoint's payload under result:

{
  "success": true,
  "result": { }
}

Errors return an appropriate HTTP status code and an error message:

{
  "error": "description of what went wrong"
}

Related Documentation

• Logs API - A guided walkthrough of querying logs over the API
• Using the CLI - Install and authenticate the RunReveal CLI