Cloud Documentation

Quick Start Guide

Get started with DiagramiQ cloud in 3 simple steps:

  1. Sign Up:

    Visit app.diagramiq.io and create your account

  2. Create a Project:

    Set up your first project and invite team members

  3. Start Diagramming:

    Use our intuitive editor with AI assistance

Workspace Setup

Configure your workspace for optimal collaboration:

  • Team Management: Add and organize team members
  • Access Controls: Set permissions and roles
  • Storage: Manage diagram storage and versions

AI Assistant Features

Our AI assistant helps you create better diagrams:

Available Commands

/suggest-layout     - Get AI-powered layout suggestions
/analyze           - Analyze diagram for best practices
/generate-doc      - Generate documentation from diagram
/optimize          - Optimize diagram layout

API Integration

Integrate DiagramiQ into your workflows using our REST API:

Authentication

# Generate API key in dashboard
curl -X POST https://api.diagramiq.io/v1/diagrams \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "System Architecture"}'

Common Operations

# List diagrams
GET /v1/diagrams

# Create diagram
POST /v1/diagrams

# Update diagram
PUT /v1/diagrams/{id}

# Share diagram
POST /v1/diagrams/{id}/share

Webhooks

Set up webhooks to receive real-time updates:

Available Events

  • diagram.created
  • diagram.updated
  • diagram.shared
  • comment.added