canonical: https://jentic.com/apis/whereby.com/whereby

# Whereby REST API

These are the reference docs for the Whereby REST API. If you haven't already read our [developer documentation]( https://docs.whereby.com/), you will want to read that first for a high level overview over the Whereby APIs. Rate limiting (throttling) We rate limit our APIs, returning a `429` status code response when your request has been throttled. You will have to wait and retry the request late. The API exposes 27 endpoints secured with bearer authentication.

## For AI agents

Programmatically create meeting, get meetings. Covers 27 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Create meeting
- Get meetings
- Delete meeting
- Query and filter Whereby REST API records by parameters
- Monitor Whereby REST API operational status and events

## Use cases

### Developer Tools Operations

Use the Whereby REST API to perform developer tools operations programmatically. The API provides 27 endpoints covering core functionality including create meeting, get meetings, get meeting.

Example prompt: Call POST /meetings to create meeting

### Automated Insights Management

Automate insights operations by combining multiple Whereby REST API endpoints. Agents can get meetings and then get meeting in a single workflow.

Example prompt: Call GET /meetings to get meetings, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Whereby REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'create meeting', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /meetings | Create meeting |
| GET | /meetings | Get meetings |
| GET | /meetings/{meetingId} | Get meeting |
| DELETE | /meetings/{meetingId} | Delete meeting |
| GET | /recordings | Get recordings |
| GET | /recordings/{recordingId} | Get recording |
| DELETE | /recordings/{recordingId} | Delete recording |
| GET | /recordings/{recordingId}/access-link | Get recording access link |

## Key resources

- **Insights** — Operations for insights
- **Meetings** — Operations for meetings
- **Recordings** — Operations for recordings
- **Rooms** — Operations for rooms
- **Summaries** — Operations for summaries

## Why Jentic

- **Setup:** Wiring the Whereby REST API by hand means placing its bearer token on every meeting and recording call against the api.whereby.dev host and handling retries yourself. Through Jentic you install once, import the Whereby REST API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Whereby puts the meeting id in the URL path (/meetings/{meetingId}), so a rule can pin your agent to reading one meeting and nothing else. You choose the operations it may call, so destructive ones like deleting a meeting or a recording are not included unless you add them.
- **Credential handling:** Your Whereby REST API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a meeting' or 'read a recording's access link', and Jentic returns the matching Whereby operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Whereby REST API use?

The Whereby REST API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create meeting with the Whereby REST API?

Yes. Use the POST /meetings endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Whereby REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create meeting through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create meeting'. Jentic returns the matching Whereby REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Whereby REST API have?

The Whereby REST API exposes 27 endpoints covering insights, meetings, recordings operations.

### Can I limit what my agent is allowed to do with the Whereby REST API?

Yes. Because you run Jentic One yourself, your own rules decide which Whereby operations the agent may call, so you can grant read-only access such as GET /meetings/{meetingId} or GET /recordings/{recordingId}/access-link while leaving destructive calls like DELETE /meetings/{meetingId} and DELETE /recordings/{recordingId} out entirely. Since Whereby carries the meeting id in the URL path, a rule can pin the agent to one meeting and nothing else. The bearer token stays with your Jentic One instance and is injected only for the operations you have allowed.