API & Integrations

Programmatic access to Ergate's proposal engine via the REST API.

2 min read · Last updated: 2026-03-17

Overview

The Ergate API lets you create proposals, trigger the AI pipeline, export documents, and receive real-time notifications — all programmatically.

Base URL: https://ergate.ai/api/v1

API access requires an API key pair. Create one from Settings > Integrations > API Keys in the dashboard.

What you can do

Create and manage proposals — full CRUD with filtering and pagination
Run the AI pipeline — trigger analysis, generation, and scoring as async operations
Export documents — generate PDF, DOCX, or PPTX and get a signed download URL
Receive webhooks — get notified in real-time when pipeline stages complete, proposals are exported, and more
Check usage — monitor your plan limits and consumption

Quick links

Authentication — API keys, scopes, and headers
Proposals — Create, list, update, and archive proposals
AI Pipeline — Trigger analysis, generation, scoring, and export
Webhooks — Register endpoints and receive event notifications
Sample Code — Complete examples in Node.js, Python, and cURL

Typical integration flow

1. Create proposal       POST /proposals         → 201
2. Trigger analysis      POST /proposals/:id/analyze   → 202
3. Webhook fires         proposal.analysis_completed
4. Trigger generation    POST /proposals/:id/generate  → 202
5. Webhook fires         proposal.generation_completed
6. (Optional) Score      POST /proposals/:id/score     → 202
7. Export                POST /proposals/:id/export    → signed URL
8. Download file         GET signed URL                → PDF/DOCX/PPTX

For simpler integrations, you can poll GET /proposals/:id and check the status field instead of using webhooks.