/api/exploration

POST /api/exploration

Changed on

Create a new exploration with a single thread, persist the user's selected metrics, dimensions, and timelines, and stamp the thread as started. Also auto-creates a placeholder Summary document in the same collection. Actual planning is async; this endpoint returns immediately with an empty queries list. Clients should poll GET /:id until the queries appear and reach a terminal status.

Accepts the per-area :blocks payload (one entry per Research-plan block), persisted verbatim, plus a thread-scoped :timeline_ids.

post/api/exploration

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

collection_idinteger nullable

value must be an integer greater than zero.

descriptionstring nullable
namestring required

value must be a non-blank string between 1 and 254 characters.

promptstring nullable
timeline_idsinteger[] nullable

Response

Successful response

archivedboolean
can_deleteboolean
can_restoreboolean
can_writeboolean
collection_idinteger nullable

value must be an integer greater than zero.

created_atunknown
creatorobject nullable
creator_idinteger required

value must be an integer greater than zero.

descriptionstring nullable
idinteger required

value must be an integer greater than zero.

namestring required
updated_atunknown

Changes