Run Flow

POST https://app.doclo.ai/api/v1/flows/{flowId}/run

Authorization: Bearer dc_live_your_api_key

{
  "version": "1.2.0",
  "wait": false,
  "timeout": 30000,
  "idempotencyKey": "unique-request-123",
  "webhookUrl": "https://your-server.com/webhook",
  "webhookSecret": "your_webhook_secret",
  "metadata": {
    "customerId": "cust_123",
    "source": "upload"
  },
  "input": {
    "document": {
      "base64": "data:application/pdf;base64,JVBERi0xLjQK...",
      "filename": "invoice.pdf",
      "mimeType": "application/pdf"
    },
    "variables": {
      "extractLineItems": true
    }
  }
}

{
  "id": "exec_abc123def456",
  "flowId": "invoice-extractor",
  "version": "1.2.0",
  "status": "pending",
  "createdAt": "2024-02-20T15:30:00Z",
  "metadata": {
    "customerId": "cust_123",
    "source": "upload"
  }
}

{
  "id": "exec_abc123def456",
  "flowId": "invoice-extractor",
  "version": "1.2.0",
  "status": "completed",
  "createdAt": "2024-02-20T15:30:00Z",
  "completedAt": "2024-02-20T15:30:12Z",
  "output": {
    "invoiceNumber": "INV-2024-001",
    "date": "2024-02-15",
    "vendor": {
      "name": "Acme Corporation",
      "address": "123 Business St, City, ST 12345"
    },
    "lineItems": [
      {
        "description": "Professional Services",
        "quantity": 10,
        "unitPrice": 150.00,
        "total": 1500.00
      }
    ],
    "subtotal": 1500.00,
    "tax": 127.50,
    "total": 1627.50
  },
  "metrics": {
    "durationMs": 12340,
    "pageCount": 2,
    "creditsUsed": 4
  },
  "metadata": {
    "customerId": "cust_123",
    "source": "upload"
  }
}

curl -X POST https://app.doclo.ai/api/v1/flows/invoice-extractor/run \
  -H "Authorization: Bearer dc_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "document": {
        "base64": "data:application/pdf;base64,JVBERi0xLjQK..."
      }
    }
  }'

curl -X POST https://app.doclo.ai/api/v1/flows/invoice-extractor/run \
  -H "Authorization: Bearer dc_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "wait": true,
    "timeout": 30000,
    "input": {
      "document": {
        "base64": "data:application/pdf;base64,JVBERi0xLjQK..."
      }
    }
  }'

curl -X POST https://app.doclo.ai/api/v1/flows/invoice-extractor/run \
  -H "Authorization: Bearer dc_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://your-server.com/doclo-webhook",
    "webhookSecret": "whsec_your_secret",
    "input": {
      "document": {
        "base64": "data:application/pdf;base64,JVBERi0xLjQK..."
      }
    }
  }'

import * as fs from 'fs';

// Read and encode document
const pdfBuffer = fs.readFileSync('invoice.pdf');
const base64 = `data:application/pdf;base64,${pdfBuffer.toString('base64')}`;

// Execute flow
const response = await fetch(
  'https://app.doclo.ai/api/v1/flows/invoice-extractor/run',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.DOCLO_API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      wait: true,
      input: {
        document: {
          base64,
          filename: 'invoice.pdf',
          mimeType: 'application/pdf'
        }
      }
    })
  }
);

const result = await response.json();

if (result.status === 'completed') {
  console.log('Invoice Number:', result.output.invoiceNumber);
  console.log('Total:', result.output.total);
} else if (result.status === 'failed') {
  console.error('Extraction failed:', result.error);
}

// Safe to retry - same idempotencyKey returns same execution
const response = await fetch(
  'https://app.doclo.ai/api/v1/flows/invoice-extractor/run',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${apiKey}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      idempotencyKey: `invoice-${documentHash}-${Date.now()}`,
      input: { document: { base64: documentData } }
    })
  }
);