Create code to diagram

Renders architecture-diagram code (restricted to the diagrams/graphviz libraries only, sandboxed and size-limited) into an image.

POST /++code_to_diagram

Computing Tools

Authentication

Requires an authenticated (logged-in) account. Also requires a registered Integrator subscription.

This endpoint requires the calling application to be registered as an Integrator. Every call must identify the registration via a registration_id parameter (or an X-Client-Id header), and authenticate using one of the following methods, selected with the subscription_method parameter:

referer — The request's HTTP Referer header must match one of the domains authorized for this Integrator registration.
ip — The request's source IP address must match one of the IP addresses authorized for this Integrator registration.
client_token — A client token issued at registration time is supplied with the request.

Request

Content type: application/x-www-form-urlencoded

Name	In	Type	Required	Description
`code`	body	string	No	—
`BODY`	body	string	No	—
`color`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`display`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`gap`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`width`	body	string	No	Sent by the web client (found via frontend call-site tracing).

Example request body

{
  "code": "example_value",
  "BODY": "example_value",
  "color": "example_value",
  "display": "example_value",
  "gap": "example_value",
  "width": "example_value"
}

Responses

Status	Meaning
`200`	Successful response.
`400`	Invalid JSON body.
`500`	No diagram generated
`401`	Unauthorized - missing or invalid Integrator authentication (registration_id/X-Client-Id, plus referer/IP/client_token).
`403`	Forbidden - the current user or Integrator registration does not have sufficient permissions.

Example response (illustrative - field names only, values are placeholders)

{
  "image": "example_value"
}

Computing Tools