Skip to main content

Welcome to the Roark API

Our API provides programmatic access to all Roark features: call monitoring, metrics collection and simulation testing.
Haven’t generated an API key yet? Generate one here

Core Endpoints

Call

Upload and analyze call recordings

Metrics

Define metrics and collect results on calls

Simulations

Test agents with synthetic callers

Getting Started

1

Generate an API Key

Create your API key in the dashboard to start making authenticated requests.
2

Review the Endpoints

Explore our available endpoints and their functionalities in the sections above.
3

Make Your First Request

Check that your key works by asking the API which credential it is. The Roark CLI is the fastest way in:
The response names the project or organization the key acts in and the permissions it holds. To check that the API is up without a key, call GET https://api.roark.ai/health.

SDKs and Libraries

Node.js SDK

Official Node.js SDK for Roark

Python SDK

Python integration library

Request constraints

Each operation documents its own request constraints and pagination parameters in this reference. The OpenAPI schema beside a field is the source of truth for its length, numeric, and array bounds, including whether a list endpoint uses a cursor or an offset.

OpenAPI Specification

The full OpenAPI 3.1 document is served unauthenticated, and every limit the API enforces appears in it as maxLength, maximum or maxItems on the field itself. It is available at three equivalent URLs:

View Full Specification

Explore our complete OpenAPI specification for detailed endpoint documentation