Workspaces

Record the first meaningful Workspace composition

Atomically records meaningful text, attached media, or an intentional content-mode choice once per Workspace.

post/workspaces/{id}/setup/composition

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/workspaces/{id}/setup/composition
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Workspace ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

origin_keystring required

Opaque browser-generated key used to reconcile an uncertain claim response

signal'text' | 'media' | 'content_mode' required

Meaningful composer interaction category

Example request

{
  "$schema": "https://example.com/api/v1/schemas/StartWorkspaceCompositionInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

claimedboolean required

Whether this request recorded the Workspace's first meaningful composition

Example response

{
  "$schema": "https://example.com/api/v1/schemas/StartWorkspaceCompositionResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.