Skip to content
Optiwork API Docs

Overview

Meeting rooms, on-demand calls and meeting recordings for the Optiwork suite.

Optiwork Call API v2026.11.06.0850

Section titled “Optiwork Call API v2026.11.06.0850”

The Optiwork Call API covers the video meetings of the Optiwork suite: meeting rooms and their permanent links, on-demand calls that ring the people you call, and the recordings of past meetings with their transcripts and AI summaries.

Base URL

All endpoints are served under the fixed Call host: https://collab.work.optidata.cloud/api.

Authentication

Every endpoint requires a Bearer JWT passport, except GET /ping. Your personal passport is available in Optiwork at https://work.optidata.cloud/user/settings/security (My account > Profile > Security), where it is shown as the authentication key. Send it on every request:

Authorization: Bearer opk_xxxxxxxxxxxxxxxxxxxxxxxx
Accept: application/json

A request without a key, or with a malformed one, returns 401. A key that is expired or not recognised returns 419; get a fresh authentication key from the same settings page and retry.

Every meeting happens in a room. A room is identified by its hash, a long random identifier that is also the room’s link: usage_url (https://collab.work.optidata.cloud/rooms/{hash}) is the address you share with participants. A room created with a room_slug also gets a permanent link (custom_hash, for example owt42-acme-weekly-sync), handy for recurring meetings.

Wherever a path takes {room}, pass the room’s hash or its custom_hash. Treat both like a password: anyone holding the link can ask to join the meeting.

Starting a meeting

  • Scheduled or ad-hoc meeting: POST /rooms/new creates a room; share its usage_url.
  • Ringing someone: POST /rooms/calls creates a room and rings the people in callee_uuids on their Optiwork apps. The other call operations report what happened next (accepted, declined, missed, ended).

Every call operation acts on your behalf, as the user of the authentication key: a field naming the actor (caller_uuid, acceptor_uuid, decliner_uuid) is optional and, when sent, must be your own uuid. On an existing room you must be a party of the call: the room’s owner, someone admitted to the room or holding a moderator or admin role in it, or someone rung into it within the last hour. Otherwise the call operations answer 403.

Conventions

  • Request bodies are JSON, except file uploads, which are multipart/form-data.
  • Timestamps are ISO-8601 in UTC (e.g. 2026-10-19T14:40:53.000000Z).
  • Validation failures return 422 with a per-field errors map. Rules the application enforces itself (a link already taken, a recording already stopped) answer with an { "error" } envelope, sometimes with status and help. Messages are written in the caller’s language.

Operations

Section titled “ Operations ”
GET
/ping
GET
/rooms
GET
/rooms/new
POST
/rooms/new
GET
/rooms/custom
DELETE
/rooms/{room}
PATCH
/rooms/{room}
GET
/rooms/{room}/info
GET
/rooms/{room}/calendar-event
POST
/rooms/calls
POST
/rooms/calls/{room}/invite
POST
/rooms/calls/{room}/accept
POST
/rooms/calls/{room}/decline
POST
/rooms/calls/{room}/miss
POST
/rooms/calls/{room}/ringtone/check
POST
/rooms/calls/{room}/end
POST
/rooms/recordings/sources/on-site
GET
/rooms/{room}/recordings/{recording}
POST
/rooms/{room}/recordings/{recording}/recovery/start
POST
/rooms/{room}/recordings/{recording}/recovery/chunks
POST
/rooms/{room}/recordings/{recording}/recovery/finish
GET
/users/{user}/dashboard

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth”

The authentication key (JWT passport) from My account > Profile > Security at work.optidata.cloud/user/settings/security.

Security scheme type: http

Bearer format: JWT