Cloudharness Dev Portal
CloudCron Schedule Next API

Generate

Endpoint:https://api.cloudharness.com

Start Mermaid diagram generation

POST
https://api.cloudharness.com
/v1/generate/mermaid

Accepts Mermaid code (or source to convert) and starts generation. Returns a response ID that can be used to retrieve results via GET /v1/generate/mermaid/{responseId}.

Start Mermaid diagram generation › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Start Mermaid diagram generation › Request Body

  • filestring · binary

    The input file containing Mermaid code or source to convert

  • textstring

    Direct text input as an alternative to file upload

  • flowchartboolean

    Whether to generate a flowchart diagram

    Default: true
  • sequenceboolean

    Whether to generate a sequence diagram

    Default: true

Start Mermaid diagram generation › Responses

Diagram generation started successfully

  • successboolean · required
  • metadataobject · required
  • statusstring · required

    Descriptive status message

  • dataobject

Get Mermaid diagram status/result

GET
https://api.cloudharness.com
/v1/generate/mermaid/{responseId}

Retrieves the status and content of a previously generated Mermaid diagram. The diagram must have been generated within the retention period.

Get Mermaid diagram status/result › path Parameters

  • responseIdstring · required

    The response ID of the Mermaid diagram to retrieve

Get Mermaid diagram status/result › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Mermaid diagram status/result › Responses

Diagram found and returned

  • successboolean · required
  • metadataobject · required
  • statusstring · required

    Descriptive status message

  • dataobject
ReportsOther endpoints