API ACCESS

Create process maps with our API

Add AI-powered process map generation to your product. BPMN compatible.

  • Add process map generation to your copilot

  • Enhance your process tools with AI

  • Generate diagrams at scale

QUICK START

Get Started in Minutes

1. Get API Access

Contact us to get your API credentials and start integrating BA Copilot into your application.

2. Test the API

Use our sandbox environment to test the API and ensure it meets your needs before going live.

3. Go Live

Switch to production credentials and start generating process maps and BPMN diagrams in your live environment.

DOCUMENTATION

API Reference

Generate Process Maps in BPMN Format

Generates three process map variations from your input (text, images, or documents), exported in BPMN format with small, medium, and large sizes.

Request
POST/v1/bpmn/generate
Content-Type: multipart/form-data

"text": "string"     // Required: Process description in plain text
"images[]": "File"     // Optional: PNG, JPG, WEBP
"docs[]": "File"     // Optional: PDF, DOCX, TXT
Response
Content-Type: application/json

{
  "bpmn": {
    "small": "<bpmn:definitions>...</bpmn:definitions>",    // BPMN 2.0 XML
    "medium": "<bpmn:definitions>...</bpmn:definitions>",
    "large": "<bpmn:definitions>...</bpmn:definitions>"
  },
  "thumbnail": {
    "type": "image/png",
    "data": "base64_encoded_string"
  }
}
Have questions?

We're happy to help with any questions pre or post implementation.

Contact support