UML

UML (Unified Modeling Language) is the standard modeling language for software architecture, system design, and technical documentation. Governed by the Object Management Group (OMG), UML defines a set of notation conventions and diagram types — class, sequence, activity, use case, state, component, deployment, and more — used across the software development lifecycle. This collection profiles the ecosystem of tools, APIs, and services that work with UML diagrams programmatically.

2 APIs 0 Features

UMLModelingDiagramsSoftware ArchitectureDesignStandards

APIs

PlantUML Server API

PlantUML Server provides a public REST API for generating UML diagrams from plain-text descriptions. Diagrams are encoded in the URL path using a deflate + base64 scheme. The se...

Kroki Diagram API

Kroki provides a unified HTTP API for generating diagrams from textual descriptions. It supports over 20 diagram types including PlantUML, Mermaid, GraphViz, BlockDiag, BPMN, C4...

Collections

Kroki Diagram API

OPEN

PlantUML Server API

OPEN

Pricing Plans

Uml Plans Pricing

3 plans

PLANS

Rate Limits

Uml Rate Limits

5 limits

RATE LIMITS

FinOps

Uml Finops

FINOPS

Semantic Vocabularies

Uml Context

6 classes · 10 properties

JSON-LD

API Governance Rules

UML API Rules

8 rules · 3 errors 5 warnings

SPECTRAL

JSON Structure

Uml Diagram Structure

0 properties

JSON STRUCTURE

Example Payloads

Kroki Post Diagram Example

4 fields

EXAMPLE

Plantuml Get Diagram Png Example

5 fields

EXAMPLE

Resources

Documentation

Documentation

SpectralRules

Sources

opencollection: 1.0.0
info:
  name: PlantUML Server API
  version: 1.0.0
items:
- info:
    name: Diagrams
    type: folder
  items:
  - info:
      name: Get Diagram as PNG
      type: http
    http:
      method: GET
      url: https://www.plantuml.com/plantuml/png/:encoded
      params:
      - name: encoded
        value: ''
        type: path
        description: Deflate + base64url encoded PlantUML source
    docs: Renders a PlantUML diagram as a PNG image. The encoded parameter is the PlantUML source compressed with deflate
      and encoded in base64url.
  - info:
      name: Get Diagram as SVG
      type: http
    http:
      method: GET
      url: https://www.plantuml.com/plantuml/svg/:encoded
      params:
      - name: encoded
        value: ''
        type: path
        description: Deflate + base64url encoded PlantUML source
    docs: Renders a PlantUML diagram as an SVG image. The encoded parameter is the PlantUML source compressed with deflate
      and encoded in base64url.
  - info:
      name: Get Diagram as ASCII Art
      type: http
    http:
      method: GET
      url: https://www.plantuml.com/plantuml/txt/:encoded
      params:
      - name: encoded
        value: ''
        type: path
        description: Deflate + base64url encoded PlantUML source
    docs: Renders a PlantUML diagram as ASCII art text. Useful for text-only environments or embedding in documentation.
  - info:
      name: Get Diagram as PDF
      type: http
    http:
      method: GET
      url: https://www.plantuml.com/plantuml/pdf/:encoded
      params:
      - name: encoded
        value: ''
        type: path
        description: Deflate + base64url encoded PlantUML source
    docs: Renders a PlantUML diagram as a PDF document.
  - info:
      name: Get Diagram HTML Image Map
      type: http
    http:
      method: GET
      url: https://www.plantuml.com/plantuml/map/:encoded
      params:
      - name: encoded
        value: ''
        type: path
        description: Deflate + base64url encoded PlantUML source
    docs: Returns an HTML image map for the diagram, enabling clickable areas on diagrams rendered as PNG.
- info:
    name: Validation
    type: folder
  items:
  - info:
      name: Validate Diagram Syntax
      type: http
    http:
      method: GET
      url: https://www.plantuml.com/plantuml/check/:encoded
      params:
      - name: encoded
        value: ''
        type: path
        description: Deflate + base64url encoded PlantUML source
    docs: Validates the PlantUML source syntax without rendering the diagram. Returns a text description of parsing results
      including any error messages.
bundled: true