Skip to content
Optiwork API Docs

Overview

Virtual offices, their worlds, avatars and chat for the Optiwork suite.

Optiwork Spaces API v2026.09.09.0839

Section titled “Optiwork Spaces API v2026.09.09.0839”

The Optiwork Spaces API covers the virtual offices of the Optiwork suite: the spaces where people walk an avatar around and talk to whoever is nearby, the worlds (maps) your company designs for them, who may design them (builders), each person’s avatar, and the chat history of a space.

Base URL

All endpoints are served under the fixed Spaces host: https://spaces.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 returns 401. An expired key returns 419. A key that is not recognised is currently refused with 403 and an empty message (or 500 when it is not a token at all). In every case, get a fresh authentication key from the same settings page and retry.

Who may do what

  • Everyone in the company can list and open every space, join it, read its chat, create spaces and choose their own avatar.
  • The owner of a space and company super-administrators can rename and archive it.
  • Builders can create and edit the company’s worlds. Super-administrators are always builders, and they decide who else is one.
  • Only super-administrators can make a world the live one.

Worlds

Every space of the company is laid out from the company’s active world. A company that never designed one uses a built-in office. A world is a Tiled map document (data), edited as a draft and then made active; version grows with every saved change. Worlds can also hold group areas: zones of the map that the members of a given group may edit even when they are not builders.

Conventions

  • Wherever a path takes {space}, pass the space’s uuid or its hash. Worlds are addressed by their identifier.
  • Request bodies are JSON.
  • Space timestamps are ISO-8601 in UTC (2026-10-19T14:52:44.000000Z); worlds, builders and chat messages carry the offset of the company’s time zone (2026-10-19T11:53:34-03:00).
  • Validation failures return 422 with a per-field errors map. A refused action returns 403 with a message. Messages are written in the caller’s language.

Operations

Section titled “ Operations ”
GET
/ping
GET
/spaces
POST
/spaces
GET
/spaces/{space}
DELETE
/spaces/{space}
PATCH
/spaces/{space}
POST
/spaces/{space}/joins/setup
GET
/spaces/{space}/chat/messages
GET
/spaces/preferences/skin
PUT
/spaces/preferences/skin
GET
/spaces/maps
POST
/spaces/maps
GET
/spaces/maps/active
GET
/spaces/maps/{map}
PATCH
/spaces/maps/{map}
PUT
/spaces/maps/{map}/draft
POST
/spaces/maps/{map}/activation
GET
/spaces/builders
POST
/spaces/builders
DELETE
/spaces/builders/{uuid}

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