Convilyn docs

API Reference

Convilyn exposes a REST API documented as OpenAPI 3.1 contracts. The reference pages below render the live contracts via Redoc.

The API reference is English only — endpoint paths, parameter names, and response schemas are themselves English. For SDK-level walkthroughs in other languages, see the SDK Overview.

Contracts

Identity & access

  • Authentication — signup, signin, tokens, OAuth, email verification, password reset

Billing & credits

  • Payment — subscriptions, invoices, payment methods, usage reporting
  • Credits — credit balance management, workflow billing

Workflows

  • Turbo Lane — direct processor jobs (image / document / OCR / media conversion)
  • Goal Lane — workflow catalog, job creation, slot filling, WebSocket event stream
  • Resume Match — interactive resume analysis (Goal Lane vertical)
  • User Workflows — Pro-tier workflow builder, fork-and-customize, community library

Files

  • Upload — file upload (multipart + SSE streaming)

Tools & catalog

  • Forge — MCP tool catalog (read-only)
  • MCP Catalog — alternative MCP tool catalog reference

Misc

Conventions

  • Base URL (production): https://api.convilyn.com/api/v1
  • Authentication: most endpoints require a Bearer token — see the Authentication contract for issuance and refresh flows
  • Idempotency: mutating verbs accept an Idempotency-Key header; the SDK auto-stamps it
  • Rate limits: HTTP 429 responses include X-RateLimit-Reset (Unix timestamp)
  • Errors: envelope { code, message, details } — the SDK exposes these as typed exceptions, see SDK Reference → Exceptions

Where to go next