OpenAPI (JSON)
Versioned HTTP contract for all public routes.
Developers
OpenAPI, health checks, and the job lifecycle.
Apilyn's HTTP contract is the versioned OpenAPI JSON and generated SDKs. Start here for discovery links, read guides at docs.apilyn.com, and wire async jobs against api.apilyn.com.
Discovery (no auth)
OpenAPI (JSON) https://api.apilyn.com/v1/openapi.json Health / ready https://api.apilyn.com/health/ready API origin https://api.apilyn.com
API reference
Use these URLs in deploy smoke tests, SDK generation, and runbooks. The API root path intentionally does not serve a homepage.
Health / ready
Load-balancer and deploy smoke check.
API origin
Base URL for authenticated requests (root path is not a landing page).
Getting started
- Create an organization. Sign in at app.apilyn.com, create an org, and issue a sandbox API key. Keep production and staging in separate orgs.
- Verify the API is reachable. Check readiness before you wire clients: GET https://api.apilyn.com/health/ready (no auth required).
- Pull the OpenAPI contract. Download https://api.apilyn.com/v1/openapi.json and generate clients, or use the Python and TypeScript SDKs shipped in the Apilyn monorepo. Narrative guides and error catalogs live at docs.apilyn.com; the schema remains the authoritative HTTP contract.
- Run the async job flow. Upload intent → complete upload → POST /v1/jobs with pipeline and webhook → poll or receive webhook → download via signed URL. See the home page integration example and engineering blog for patterns.
Product documentation
docs.apilyn.com is the public developer portal—quickstart, authentication, jobs, webhooks, recipes, error codes, and an OpenAPI endpoint index. Download the live schema from the discovery links above for SDK generation.
FAQ
Developer FAQ
Where is the product documentation?
Narrative guides (quickstart, jobs, webhooks, recipes, error codes) live at docs.apilyn.com. The versioned HTTP contract is the OpenAPI document at api.apilyn.com/v1/openapi.json, plus generated Python and TypeScript SDKs in the Apilyn repository.
Why does the API root URL return 404?
api.apilyn.com is an API origin, not a marketing landing page. Use /health/ready for readiness checks and /v1/openapi.json for the schema. Authenticated routes live under /v1/.
How do I authenticate?
Send Authorization: Bearer <api_key> on requests after issuing keys from app.apilyn.com. Keys are org-scoped; rotate them from the dashboard and store them in your secret manager.