For the complete documentation index, see llms.txt. This page is also available as Markdown.

Workspace activation

Get Workspace Activation

get

Where a workspace stands on its first successful request.

Readable by any member who can see the workspace. Whether the guide should actually be offered to this caller is experience_eligible, which also answers false when the deployment has the flow turned off (activation_guide), so a dashboard left open stops offering it without needing to be reloaded.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
Responses
200

Successful Response

application/json

Where a workspace stands on its first successful request.

dismissedbooleanRequired

Whether someone skipped the guide for this workspace.

experience_eligiblebooleanRequired

Whether the dashboard should offer the guide to this caller right now: the deployment has it enabled, the workspace is classified for it, nobody dismissed it, no request has succeeded yet, and the caller may manage the workspace.

statusstring · enumRequired

'activated' once a gateway request in this workspace has succeeded, 'failed' when the last one failed and none has yet succeeded, 'waiting' when there has been none at all.

Possible values:
get/api/v1/workspaces/{workspace_id}/activation
GET /api/v1/workspaces/{workspace_id}/activation HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "activation_attempt": {
    "cost_usd": 1,
    "error_category": "invalid_request",
    "latency_ms": 1,
    "model": "text",
    "occurred_at": "text",
    "provider": "text",
    "request_id": "text",
    "status": "success"
  },
  "dismissed": true,
  "experience_eligible": true,
  "latest_attempt": {
    "cost_usd": 1,
    "error_category": "invalid_request",
    "latency_ms": 1,
    "model": "text",
    "occurred_at": "text",
    "provider": "text",
    "request_id": "text",
    "status": "success"
  },
  "status": "waiting"
}

Dismiss Workspace Activation

post

Retire the guide for this workspace. Permanent, and idempotent.

Workspace owners and admins only. It retires the card and nothing else: the key the guide issued keeps working, because the operator asked for it and may well have pasted it somewhere already. Revoking one is the Keys page's job.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
Responses
200

Successful Response

application/json

A human-readable acknowledgment for an operation with nothing to return.

messagestringRequired

What happened.

post/api/v1/workspaces/{workspace_id}/activation/dismiss
POST /api/v1/workspaces/{workspace_id}/activation/dismiss HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "message": "text"
}

Create Workspace Activation Key

post

Issue the workspace's setup API key, rotating the one the guide already issued.

Workspace owners and admins only, like every other action that changes a workspace. The plaintext is returned once and never stored, so a reopened guide rotates the same key row rather than collecting a second one, and answers 409 once the workspace has activated or the guide was dismissed.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
Responses
201

Successful Response

application/json

The API key the guide hands out, with its plaintext.

Returned once, on the press that asked for it, and never stored in plaintext, like every other key this gateway mints.

keystringRequired
key_idstringRequired
key_namestring · nullableRequired
key_prefixstring · nullableRequired
key_suffixstring · nullableRequired
post/api/v1/workspaces/{workspace_id}/activation/key
POST /api/v1/workspaces/{workspace_id}/activation/key HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "key": "text",
  "key_id": "text",
  "key_name": "text",
  "key_prefix": "text",
  "key_suffix": "text"
}

Last updated

Was this helpful?