Context
HTTP API route for reviewed shared Context suggestions.
| Route | Use | CLI equivalent |
|---|---|---|
POST /context/suggestions | Read, submit, list, or withdraw a reviewed shared Context suggestion. | `ax context suggest --file <PATH |
The route requires an API key and an organization selected through org_id
when the key can access more than one organization. The feature must be enabled
for that organization. Shared Context stays read-only: this route cannot make a
direct change or decide a suggestion. List and withdraw actions operate only on
the authenticated user's own suggestions.
POST /api/v1/context/suggestions
Send one suggestion workflow action.
curl -X POST \
-H "Authorization: Bearer $AX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"action":"list","pendingOnly":true}' \
"https://app.514.ax/api/v1/context/suggestions?org_id=$AX_ORG_ID"| Action | Required fields | Result |
|---|---|---|
snapshot | kind (product, use_case, persona, or agent), targetId | Current editable fields and revision. |
submit | Snapshot target and baseRevision, proposed, reason, evidence, idempotencyKey | Suggestion id, status, and version. |
list | None | Your suggestions and nextPageToken. Set pendingOnly to only return pending records. |
withdraw | Suggestion id, version | Updated suggestion id, status, and version. |
proposed may contain only editable fields for the target kind. evidence is
an array of up to five {url, description} values. idempotencyKey is a UUID;
reuse it when retrying the same submission. To replace a pending suggestion,
send both replacesRequestId and expectedVersion.
If the shared record changed after the snapshot, refresh it and submit a new
proposal. A 409 response means the submitted version conflicts with the
current review state. Invalid input returns 400; an unavailable target or
feature returns 404; request limits return 429.