Your first API call
With a personal access token, find your workspace, list your diagrams and download one view as SVG. Four requests.
You will ask the API who your token is, list the diagrams of your workspace, pick one, and download one of its views as an SVG file. Every request is an HTTPS call with your token in a header; use the HTTP tool you like. The examples use the Claims Platform diagram of Alex Morgan.
Get a token (free, no AI)
You need a personal access token with the cartouche.read scope. There is no screen to create one yet: write to support@iyedy.com and say what it is for. See Create and manage API tokens.
Keep it in an environment variable of your shell or in your tool's secret store, never in a file you commit. In the requests below, crt_pat_… stands for your token.
crt_pat_.Ask who you are (free, no AI)
GET /v1/token HTTP/1.1
Host: app.iyedy.com
Authorization: Bearer crt_pat_…
The answer describes the token: its name, who it acts as, its scopes, its expiry, the organisation in tenantId, and the workspaces it reaches in workspaces, each with id, name and role. Your personal workspace is named My diagrams.
tenantId and the id of the workspace you want to read.List your diagrams (free, no AI)
Put the two ids of step 2 in the path:
GET /v1/t/{tenantId}/w/{workspaceId}/diagrams HTTP/1.1
Host: app.iyedy.com
Authorization: Bearer crt_pat_…
The answer lists the diagrams you can read in docs. Each one has its id in did (d_ followed by 10 characters), its name and its version.
did.Download a view (free, no AI)
List the views of the diagram:
GET /v1/t/{tenantId}/w/{workspaceId}/diagrams/{did}/views HTTP/1.1
Host: app.iyedy.com
Authorization: Bearer crt_pat_…
Each view has a uid, a handle, a name and a type. Take the containers view and ask for it as SVG, with its uid or its handle:
GET /v1/t/{tenantId}/w/{workspaceId}/diagrams/{did}/views/{view}?format=svg HTTP/1.1
Host: app.iyedy.com
Authorization: Bearer crt_pat_…
The SVG comes back as a file to save, for example containers.svg. The other formats are mermaid, plantuml, drawio, and json for the view's layout.
containers.svg opens in your browser and shows the containers view of Claims Platform.Next
- Run the checks on the diagram in a pipeline, or follow what depends on an element: API overview.
- Give each job only the scopes it needs: Scopes.
- Handle
429and the other errors: Rate limits and errors.
Was this tutorial helpful?Your answer is anonymous and counts only if you accepted measurement.
What went wrong?
Don't write personal data.