Skip to main content
 print this page

Get workbook details, messages, or queries

GET 
/workbooks/:workbook_id

Returns one of three shapes, selected by the action query parameter. The caller needs read-only access or higher on the workbook.

  • Without action: the workbook record (QueryWorkbookDetails).

  • action=retrieve_messages: a paginated conversation history. In an environment where AI services are disabled this returns an empty object instead, so check for the messages key rather than assuming the conversation is empty. Note that reading messages has a side effect: once a workbook exceeds 2000 messages the oldest are deleted.

  • action=retrieve_queries: a paginated list of the queries run in this workbook. Records already in a terminal state carry a reduced attribute set that omits CreatedBy and QuerySource, whereas still-running records are refreshed from the engine and carry the full set, so the two differ.

The action enum below is stricter than the backend, which accepts any value and silently falls back to returning the workbook record. This differs from PUT on the same path, which rejects unknown actions.

Note that an unknown workbook id is reported as HTTP 400 with IPV-1002, not 404.

Request​

Responses​

The workbook record, a page of messages, or a page of queries, depending on action.

Response Headers
    Access-Control-Allow-Origin
    Access-Control-Allow-Methods
    Access-Control-Allow-Headers
    Content-Encoding

    Set to "gzip" when the request asked for compression.