Skip to content

Search stays in your browser.

Open app

List bounded future-facing guidance for the creating or assigned investigation agent.

GET /api/v1/interactions/{interactionId}/guidance

Only the authorized creating agent or the single immutable assigned agent of a contextual investigation can retrieve its guidance. Current exact source authority is required. Guidance is separate from conversation, Decisions, and lifecycle state.

Use a credential with commentary.interactions.read.

Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. Set up developer access.

Name Location Type Required Description
interactionId path string Yes Opaque Interaction id.
limit query integer No
cursor query string No
X-Commentary-Workspace-Id header string No Must match the credential workspace. This header cannot widen grant authority.
X-Correlation-Id header string No

Replace path placeholders and your credential. For body operations, create request.json using the required fields above; this command does not invent resource identifiers or consent.

Terminal window
curl --request GET \
'https://commentary.dev/api/v1/interactions/<interactionId>/guidance' \
--header 'Authorization: Bearer <your-token>'
Status Meaning Payload
200 Successful response. object
400 The request was invalid. ExternalError
401 Authentication is required. ExternalError
403 The token or session does not have permission for this resource. ExternalError
404 The resource was not found. ExternalError
429 The request was rate limited. ExternalError
Field Type Required Description
data array of InteractionGuidance Yes
nextCursor string or null Yes

Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.

Operation ID: listInteractionGuidance. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.