simulate Agent Inbox Policy

POST /api/v1/inbox/policies/simulate

Account-scoped HTTP v1 agent operation within the credential’s fixed workspace and current owner/source authority. Workspace selection never changes browser preferences. Policies cannot be activated by an agent. Insights require a 20-observation cohort; delivery history omits titles and app paths.

Access

Use a credential with commentary.inbox.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.

Parameters

Name	Location	Type	Required	Description
`X-Commentary-Workspace-Id`	header	string	No	Must match the credential workspace. This header cannot widen grant authority.
`X-Correlation-Id`	header	string	No

Request body

Required. Supported content types: application/json.

Field	Type	Required	Description
`definition`	InboxAttentionPolicyDefinition	Yes
`entryId`	string	Yes

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/inbox/policies/simulate' \
  --header 'Authorization: Bearer <your-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

Status	Meaning	Payload
`200`	Authorized response. Reads never mark recipient state or apply policy effects. Proposals are disabled and pending human approval.	object
`400`	Invalid input.	InteractionApiError
`401`	A valid bearer token is required.	See response headers or body contract
`403`	The grant, workspace, membership, scope, feature, or source authority does not authorize this action.	See response headers or body contract
`404`	Authorized resource or item was not found.	See response headers or body contract
`409`	The version, retry key, or proposal limit conflicts.	See response headers or body contract
`500`	The request could not be completed.	See response headers or body contract
`503`	Source access or projection is temporarily unavailable.	See response headers or body contract

Successful response fields

Field	Type	Required	Description
`data`	object	Yes

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