On this page

REST API Reference

Base address https://meet.respiresoft.com/api/v1. JSON in, JSON out.

The pages below are written from the API contract (server/contract/openapi.yaml, OpenAPI 3.1), so they list every operation with its parameters, answers and errors. Each has a curl and a Node example you can run with your own test key.

Page	Operations
Rooms	Create, list, get, change and delete rooms
Meeting tokens	Make a token for one person, check a token
Live control	Presence, end, mute, remove, message, lock
Sessions and transcripts	Sittings, participants, transcripts, chat
Recordings	List, read, download link, delete
Usage	Usage per day or month, monthly estimate
Webhook endpoints	Endpoints, tests, deliveries, events

Conventions#

Address. https://meet.respiresoft.com/api/v1/.... JSON bodies need Content-Type: application/json.
Authentication. Authorization: Bearer mk_test_... or mk_live_.... A test key sees test data and a live key sees live data. See Projects and API keys.
Request id. Every answer has a Request-Id header.
Idempotency. POST accepts Idempotency-Key and repeats the first answer for 24 hours.
Rate limit. 120 requests a minute for each key. Past that 429 with Retry-After. See Limits.
Lists. limit from 1 to 100 (default 10) and starting_after (the id of the last item). Newest first. The answer is {"object": "list", "data": [], "has_more": false}.
Errors. {"error": {"code", "message", "param"?}}. See Errors.
Every object has "object": "<type>", and rooms and sessions carry livemode.

The project and mode of the key#

GET /api/v1/whoami

Response

200 The key's project

Field	Type	Description
`project`	object
`project.id`	string
`project.name`	string
`project.slug`	string
`mode`	string	One of `test`, `live`
`key_prefix`	string

json

{
  "project": {
    "id": "6f1c2b7e-3a54-4d0e-9c1b-2f7a8e5d4c10",
    "name": "order-1042",
    "slug": "slug"
  },
  "mode": "test",
  "key_prefix": "key_prefix"
}

Errors

Status	Meaning
401	`invalid_api_key` or `revoked_api_key`
429	`rate_limited`; wait `Retry-After` seconds

Every error has the shape {"error": {"code", "message", "param"?}}. See Errors.

Examples

bash

curl "https://meet.respiresoft.com/api/v1/whoami" \
  -H "Authorization: Bearer $MEET_API_KEY"

javascript

import { Meet } from "@respiresoft/meet";

const meet = new Meet({ apiKey: process.env.MEET_API_KEY });
const who = await meet.whoami();
console.log(who.project.name, who.mode);