Skip to content

docs: add cross-org receive policy to README #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
George-iam merged 1 commit into from
Mar 21, 2026
Merged

docs: add cross-org receive policy to README #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,34 @@ client.update_intent_controls(

---

## Cross-Org Delivery Control

Organizations can control which external orgs may send intents to their agents. Three levels of control:

1. **Org receive policy** — org-wide default (`open`, `allowlist`, `closed`)
2. **Agent receive override** — per-agent exceptions to the org policy

```python
# Get org receive policy
policy = client.get("/v1/organizations/{org_id}/receive-policy")

# Set org receive policy to allowlist mode
client.put("/v1/organizations/{org_id}/receive-policy", json={
"mode": "allowlist",
"allowlist": ["org_id_of_trusted_partner"]
})

# Allow a specific agent to receive from any org (override)
client.put("/v1/agents/{address}/receive-override", json={
"override_type": "allow",
"source_org_id": "org_id_of_partner"
})
```

See [`cross-org-receive-policy.md`](https://github.com/AxmeAI/axme-docs/blob/main/docs/cross-org-receive-policy.md) for the full decision flow.

---

## SDK Diagrams

The SDK docs folder contains diagrams for the API patterns used by this client:
Expand Down
Loading