Guide
Eraser Endpoint
Eraser endpoints connect Gateway to Eraser diagram generation so users and agents can create architecture diagrams from governed workflows.
Endpoint Kind
Use eraser as the endpoint kind when creating this endpoint through the API or dashboard.
What Gateway Uses This Endpoint For
- Generate ER diagrams, flowcharts, sequence diagrams, and architecture diagrams.
- Let AI Orchestration turn system context into visual documentation artifacts.
- Centralize Eraser API token handling.
- Audit diagram-generation activity from tools and agents.
Basic Endpoint Shape
json
{
"endpoint": "eraser-prod",
"kind": "eraser",
"config": {
"read_conn": {
"api_key": "secret",
"base_url": "https://app.eraser.io"
}
}
}Create it with the endpoint API:
bash
curl -sS -X POST "$EDEN/endpoints" \
-H "$AUTH_HEADER" \
-H "Content-Type: application/json" \
-d '{
"endpoint": "eraser-prod",
"kind": "eraser",
"config": {
"read_conn": {
"api_key": "secret",
"base_url": "https://app.eraser.io"
}
}
}'Configuration Fields
| Field | Purpose |
|---|---|
api_key | Eraser API token |
base_url | Optional Eraser base URL override |
Operating Notes
- Review generated diagrams before sharing externally.
- Avoid sending secrets or customer data in diagram prompts.
- Use this endpoint with documentation workflows and architecture review workflows.