Skip to documentation
Markdown version →

Prepared opening

Choose up to three existing Insight/Idea pairs for a prepared workspace introduction. Order and product-area wording are presentation settings. Saving does not validate Insights, approve Ideas, edit evidence, reset onboarding or send invitations. The API key selects the workspace.

2 endpoints

GET

Read the opening selection

GET /external/v1/prepared-opening

Read the saved sequence before editing. Retain updatedAt for the next save.

Requirements

API scopes required:
insights:read
ideas:read

Responses

200
Success

The saved presentation selection and its update timestamp. selection is null when none is saved.

403
Scope required

Both Insight and Idea scopes for the requested operation are required.

Example Response

200 OK
json
{
  "selection": {
    "productLabel": "areas",
    "entries": []
  },
  "updatedAt": "2026-11-01T00:00:00.000Z"
}
PUT

Save the opening selection

PUT /external/v1/prepared-opening

Replace the sequence. Each pair must already be linked in this workspace, remain active and have supporting Evidence. Entries must use distinct native UUIDs. productLabel is products or areas. expectedUpdatedAt must equal the last read timestamp, or null for the first save. Empty entries restore automatic ranking. Re-read before retrying an uncertain save. Deleted, rejected, unlinked or unreadable pairs are omitted from the opening; when no pair remains usable, automatic ranking applies.

Requirements

API scopes required:
insights:write
ideas:write

Request

Parameters

NameTypeDescription
entries *arrayUp to three ordered objects containing insightId and ideaId UUIDs. Optional evidenceIds selects up to three distinct active Evidence quotations already linked to that Insight.
productLabel *stringproducts or areas; changes opening wording only.
expectedUpdatedAt *string | nullExact updatedAt from the last read; null if none exists.

Responses

200
Success

The saved presentation selection and its update timestamp. selection is null when none is saved.

403
Scope required

Both Insight and Idea scopes for the requested operation are required.

400
Invalid selection

Malformed, duplicate, foreign, inactive, unsupported or unlinked records.

409
Changed since read

Read the selection again and reconcile the edit.

Example Request

PUT
/external/v1/prepared-opening
curl
curl -X PUT 'https://zentrik.ai/api/external/v1/prepared-opening' -H 'Authorization: Bearer YOUR_API_KEY' -H 'Content-Type: application/json' -d '{"productLabel":"areas","entries":[],"expectedUpdatedAt":null}'

Example Response

200 OK
json
{
  "selection": {
    "productLabel": "areas",
    "entries": []
  },
  "updatedAt": "2026-11-01T00:00:00.000Z"
}