Sign in
matrices
workflow-agent

Get Matrix Structure

Changed on

Get matrix structure metadata for understanding cell data.

Provides information about:

  • Matrix type and dimensionality
  • Entity sets (what entities are on each axis)
  • Entity roles (DOCUMENT, LEFT, RIGHT, QUESTION)
  • System placeholders (@{{LEFT}}, @{{RIGHT}})
  • Cell structure (what data each cell contains)

This helps workflow agents understand how to interpret matrix data when generating documents from cell data.

get/api/v1/matrices/{matrixId}/structure

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

matrixIdinteger required

Headers

authorizationstring nullable
x-api-keystring nullable

Response

Successful Response

matrixIdinteger required
matrixNamestring required
matrixType'standard' | 'cross_correlation' | 'generic_correlation' | 'synopsis' required

Types of matrices - determines cell creation strategy.

explanationstring required
rolesExplanationobject required
systemPlaceholdersobject required
cellStructurestring required

Changes

  • a93dbe19b3e6Revision changes
    • warning

      added the new synopsis enum value to the response property for the response status