{"openapi":"3.1.0","info":{"title":"A3E API","version":"1.0","description":"Documents, web capture, speech and monitoring over HTTP. One API key in the X-API-Key header. Get a free key with POST /v1/auth/signup - no card.\n\nPlans (USD, monthly):\n- Free: $0/month - 250 calls / month, 60 requests / minute\n- Starter: $29/month - 25,000 calls / month, 300 requests / minute\n- Pro: $99/month - 150,000 calls / month, 600 requests / minute\n- Enterprise: $299/month - uncapped calls, 3,000 requests / minute","contact":{"email":"info@a3eecosystem.com","url":"https://api.a3eecosystem.com/"},"termsOfService":"https://a3eecosystem.com/terms.html"},"servers":[{"url":"https://api.a3eecosystem.com"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/audio/tts":{"post":{"summary":"Text to speech","operationId":"post_v1_audio_tts","description":"Text in, an MP3 out. Voice list at /v1/audio/tts/voices.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TTSRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"audio/mpeg":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/audio/tts/voices":{"get":{"summary":"List text-to-speech voices","operationId":"get_v1_audio_tts_voices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/auth/signup":{"post":{"summary":"Create a free API key","operationId":"post_v1_auth_signup","responses":{"200":{"description":"Your API key","content":{"application/json":{"schema":{"type":"object"}}}}},"security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}}}}}}},"/v1/document/pdf-compress":{"post":{"summary":"Compress a PDF","operationId":"post_v1_document_pdf_compress","description":"Image recompression and font subsetting. Up to 96% on photo-heavy files; never returns a file larger than the one you sent.","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_compress_pdf_v1_document_pdf_compress_post"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/document/pdf-merge":{"post":{"summary":"Merge PDFs","operationId":"post_v1_document_pdf_merge","description":"Several PDFs in, one PDF out, in the order you sent them.","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_merge_pdfs_v1_document_pdf_merge_post"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/document/pdf-split":{"post":{"summary":"Split a PDF","operationId":"post_v1_document_pdf_split","description":"Pull a page range out of a PDF.","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_split_pdf_v1_document_pdf_split_post"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/document/pdf-to-image":{"post":{"summary":"PDF to image","operationId":"post_v1_document_pdf_to_image","description":"Rasterise any page of a PDF at the DPI you ask for.","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_pdf_to_image_v1_document_pdf_to_image_post"}}},"required":true},"responses":{"200":{"description":"Success","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/email/verify":{"post":{"summary":"Email verification","operationId":"post_v1_email_verify","description":"Syntax, domain, MX and disposable-provider checks on an address.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerifyRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/qr/generate":{"post":{"summary":"QR code","operationId":"post_v1_qr_generate","description":"Any string in, a PNG QR code out.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QRRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/saas/monitor/check/{monitor_id}":{"post":{"summary":"Check a watched page for changes","operationId":"post_v1_saas_monitor_check_monitor_id","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/saas/monitor/create":{"post":{"summary":"Change monitor","operationId":"post_v1_saas_monitor_create","description":"Watch a page for content changes. Create, then GET /v1/saas/monitor/check/{id}.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebMonitorCreate"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/saas/uptime/check/{monitor_id}":{"post":{"summary":"Run an uptime check now","operationId":"post_v1_saas_uptime_check_monitor_id","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/saas/uptime/create":{"post":{"summary":"Uptime monitor","operationId":"post_v1_saas_uptime_create","description":"Register a URL and poll its status. Create, list, then GET /v1/saas/uptime/status/{id} or /check/{id}.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UptimeMonitorCreate"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/saas/uptime/list":{"get":{"summary":"List your uptime monitors","operationId":"get_v1_saas_uptime_list","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/saas/uptime/status/{monitor_id}":{"get":{"summary":"Uptime monitor status","operationId":"get_v1_saas_uptime_status_monitor_id","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/web/pdf-render":{"post":{"summary":"HTML to PDF","operationId":"post_v1_web_pdf_render","description":"Your HTML, laid out by a real browser engine, back as a PDF.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFRenderRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/web/screenshot":{"post":{"summary":"Screenshot","operationId":"post_v1_web_screenshot","description":"Renders a URL in a real browser and returns the PNG.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenshotRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}},"/v1/web/seo-audit":{"post":{"summary":"SEO audit","operationId":"post_v1_web_seo_audit","description":"Fetches a page and scores title, meta, headings, images and links.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SEOAuditRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unknown or revoked API key"},"402":{"description":"Monthly quota for your plan is used up"},"429":{"description":"Over your plan's per-minute rate"}}}}},"components":{"schemas":{"Body_merge_pdfs_v1_document_pdf_merge_post":{"properties":{"files":{"items":{"type":"string","contentMediaType":"application/octet-stream"},"type":"array","title":"Files"}},"type":"object","required":["files"],"title":"Body_merge_pdfs_v1_document_pdf_merge_post"},"Body_split_pdf_v1_document_pdf_split_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"pages":{"type":"string","title":"Pages","default":"1"}},"type":"object","required":["file"],"title":"Body_split_pdf_v1_document_pdf_split_post"},"SEOAuditRequest":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"SEOAuditRequest"},"Body_compress_pdf_v1_document_pdf_compress_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_compress_pdf_v1_document_pdf_compress_post"},"ScreenshotRequest":{"properties":{"url":{"type":"string","title":"Url"},"width":{"type":"integer","title":"Width","default":1280},"height":{"type":"integer","title":"Height","default":720},"full_page":{"type":"boolean","title":"Full Page","default":false},"format":{"type":"string","title":"Format","default":"png"}},"type":"object","required":["url"],"title":"ScreenshotRequest"},"Body_pdf_to_image_v1_document_pdf_to_image_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"page":{"type":"integer","title":"Page","default":1},"dpi":{"type":"integer","title":"Dpi","default":150}},"type":"object","required":["file"],"title":"Body_pdf_to_image_v1_document_pdf_to_image_post"},"PDFRenderRequest":{"properties":{"url":{"type":"string","title":"Url","default":""},"html":{"type":"string","title":"Html","default":""}},"type":"object","title":"PDFRenderRequest"},"EmailVerifyRequest":{"properties":{"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"EmailVerifyRequest"},"UptimeMonitorCreate":{"properties":{"url":{"type":"string","title":"Url"},"name":{"type":"string","title":"Name","default":""},"check_interval_sec":{"type":"integer","title":"Check Interval Sec","default":300},"alert_email":{"type":"string","title":"Alert Email","default":""}},"type":"object","required":["url"],"title":"UptimeMonitorCreate"},"WebMonitorCreate":{"properties":{"url":{"type":"string","title":"Url"},"name":{"type":"string","title":"Name","default":""},"alert_email":{"type":"string","title":"Alert Email","default":""}},"type":"object","required":["url"],"title":"WebMonitorCreate"},"QRRequest":{"properties":{"data":{"type":"string","title":"Data"},"size":{"type":"integer","title":"Size","default":10},"border":{"type":"integer","title":"Border","default":2},"color":{"type":"string","title":"Color","default":"#000000"},"background":{"type":"string","title":"Background","default":"#FFFFFF"},"format":{"type":"string","title":"Format","default":"png"}},"type":"object","required":["data"],"title":"QRRequest"},"TTSRequest":{"properties":{"text":{"type":"string","title":"Text"},"voice":{"type":"string","title":"Voice","default":"en-US-AriaNeural"},"rate":{"type":"string","title":"Rate","default":"+0%"},"pitch":{"type":"string","title":"Pitch","default":"+0Hz"}},"type":"object","required":["text"],"title":"TTSRequest"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}}}}