Ellon AI API

curl https://www.ellon.ai/api/v1/subscriptions/me \
  -H "X-API-Key: $ELLON_API_KEY"

{
  "error": {
    "code": "plan_limit_exceeded",
    "message": "Monthly translation page limit reached. Used 1200/1000 pages this billing period.",
    "details": {
      "feature": "translation",
      "used": 1200,
      "limit": 1000
    }
  }
}

{
  "error": {
    "code": "<stable_identifier>",
    "message": "<human-readable message>",
    "details": <optional object with structured info>
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Redaction job not found.",
    "details": null
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "details": {
      "errors": [
        {
          "type": "missing",
          "loc": ["body", "document_id"],
          "msg": "Field required",
          "input": null
        }
      ]
    }
  }
}

curl https://www.ellon.ai/api/v1/documents/upload \
  -H "X-API-Key: $ELLON_API_KEY" \
  -F "file=@contract.pdf"

# 1. Create the job
curl https://www.ellon.ai/api/v1/translation-jobs \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document_id": "8f1c9d42-4b6e-4c8a-9f3d-1e2a7b6c5d4f",
    "target_language": "fr",
    "output_format": "single",
    "column_to_keep": "translated"
  }'

# 2. Poll status until "status": "completed"
curl https://www.ellon.ai/api/v1/translation-jobs/$JOB_ID \
  -H "X-API-Key: $ELLON_API_KEY"

# 3. Download the result
curl https://www.ellon.ai/api/v1/translation-jobs/$JOB_ID/download \
  -H "X-API-Key: $ELLON_API_KEY" \
  -o translated.docx

# 1. Kick off detection
curl https://www.ellon.ai/api/v1/redaction-jobs \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document_id": "8f1c9d42-4b6e-4c8a-9f3d-1e2a7b6c5d4f",
    "redaction_style": "blackbar",
    "language": "en"
  }'

# 2. Poll until detected_entities is populated
curl https://www.ellon.ai/api/v1/redaction-jobs/$JOB_ID \
  -H "X-API-Key: $ELLON_API_KEY"

# 3. Confirm the selection and run the redaction
curl https://www.ellon.ai/api/v1/redaction-jobs/$JOB_ID/confirm \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"selected_entity_ids": ["e_1","e_2","e_3"]}'

# 4. Download the redacted file
curl https://www.ellon.ai/api/v1/redaction-jobs/$JOB_ID/download \
  -H "X-API-Key: $ELLON_API_KEY" \
  -o redacted.docx

curl https://www.ellon.ai/api/v1/compare-jobs \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "original_document_id": "8f1c9d42-4b6e-4c8a-9f3d-1e2a7b6c5d4f",
    "revised_document_id": "2d7a8b93-1f4c-4a6d-b8e5-5c3f9a1d6e2b",
    "enable_semantic_analysis": true
  }'

curl https://www.ellon.ai/api/v1/analysis-jobs \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "document_id": "8f1c9d42-4b6e-4c8a-9f3d-1e2a7b6c5d4f",
    "jurisdiction": "uk",
    "contract_type": "nda",
    "language": "en"
  }'

# 1. Create a campaign
CAMPAIGN_ID=$(curl -s https://www.ellon.ai/api/v1/outreach/campaigns \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 law firms — DACH",
    "context": {
      "affiliate_link": "https://ellon.ai?ref=$YOUR_CODE",
      "prospect_context": "Mid-size law firms in Germany with active translation pipelines",
      "target_market": "Germany · DACH",
      "target_role": "Partner · Managing Director",
      "pain_points": "Slow turnaround on multi-language contract reviews",
      "tone": "warm",
      "language": "en",
      "cta_style": "soft",
      "email_length": "short"
    }
  }' | jq -r .id)

# 2. Pre-flight the suppression check (optional)
curl -s https://www.ellon.ai/api/v1/outreach/check-status \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails": ["anna@kanzlei-beispiel.de", "marc@law-example.de"]}'

# 3. Add recipients (server flags existing Ellon users as "protected")
curl -s "https://www.ellon.ai/api/v1/outreach/campaigns/$CAMPAIGN_ID/recipients" \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recipients": [
      {"email": "anna@kanzlei-beispiel.de", "first_name": "Anna", "company": "Kanzlei Beispiel"},
      {"email": "marc@law-example.de", "first_name": "Marc", "company": "Law Example"}
    ]
  }'

# 4. Check quota before spending tokens
curl -s https://www.ellon.ai/api/v1/outreach/quota \
  -H "X-API-Key: $ELLON_API_KEY"

# 5. Generate drafts for every recipient with status="ready"
curl -s "https://www.ellon.ai/api/v1/outreach/campaigns/$CAMPAIGN_ID/generate" \
  -H "X-API-Key: $ELLON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recipient_ids": []}'

# 6. Mark a recipient as contacted after you send
curl -s -X POST \
  "https://www.ellon.ai/api/v1/outreach/campaigns/$CAMPAIGN_ID/recipients/$RID/mark-contacted" \
  -H "X-API-Key: $ELLON_API_KEY"

curl https://www.ellon.ai/api/v1/subscriptions/usage \
  -H "X-API-Key: $ELLON_API_KEY"

# Example: generate a TypeScript client
npx @hey-api/openapi-ts \
  --input https://www.ellon.ai/api/public/openapi.json \
  --output ./src/ellon-client