Skip to content

Overview

Conversations, channels, messages, reactions, polls and attachments for the Optiwork suite.

The Talk API is the messaging surface of Optiwork: the conversations a user takes part in — private one-to-one chats, groups and company-wide channels — the messages exchanged in them, and everything hanging off a message: files, reactions, polls, mentions and replies.

It also exposes a per-conversation change journal, so an integration can keep an external copy of a conversation up to date without polling the whole message history.

Accounts, groups and notifications live in the Optiwork reference; files and folders in the Drive reference. Each is served from its own host and accepts the same authentication key.

Base URL

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

Authentication

Every endpoint (except GET /ping) requires a Bearer JWT passport. 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

Passports are short-lived; when a request returns 401, get a fresh authentication key from the same settings page and retry.

Conventions

  • A conversation is addressed by its numeric id; a user is addressed by a numeric id on conversation routes and by UUID on the direct-message and dashboard routes. Which one applies is stated on every parameter.
  • Timestamps are ISO-8601 UTC strings (e.g. 2026-08-17T19:54:34.000000Z).
  • Validation failures return 422 with a per-field errors map.
  • List endpoints are paginated with Laravel’s paginator envelope; a few return a plain array. The response of each operation says which.
  • Deleting a message or a conversation is a soft delete: the record keeps its id and gains a deleted_at timestamp.
  • Requests are rate limited per authenticated user; exceeding the limit returns 429.

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

Security scheme type: http

Bearer format: JWT