Send separate future guidance to the creating agent or your investigation's assigned agent.

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

Same-origin human action. Delivery marks the card read but never changes the current request, lifecycle, bucket, rank, conversation, or Decisions.

Access

Use a credential with the authentication scheme documented in the API contract.

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.

Parameters

Name	Location	Type	Required	Description
`interactionId`	path	string	Yes	Opaque Interaction id.
`If-Match`	header	string	Yes
`Idempotency-Key`	header	string	Yes

Request body

Required. Supported content types: application/json.

Field	Type	Required	Description
`revisionId`	string	Yes
`scope`	`"similar_items"` · `"same_source"` · `"agent_behavior"` · `"general"`	Yes
`body`	string	Yes	Minimum length: 1. Maximum length: 16384.

Call the endpoint

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.

curl --request POST \
  'https://commentary.dev/api/v1/interactions/<interactionId>/guidance' \
  --header 'Authorization: Bearer <your-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

Status	Meaning	Payload
`200`	Successful response.	object
`201`	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
`409`	The Interaction revision or idempotency request conflicts.	See response headers or body contract
`410`	Interaction content was purged.	See response headers or body contract
`412`	If-Match is stale or malformed.	See response headers or body contract
`428`	If-Match is required.	See response headers or body contract
`429`	The request was rate limited.	ExternalError

Successful response fields

Value type: object.

Recover from errors

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: createInteractionGuidance. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.