API Reference
Programmatic access to Zephly — create workflows, execute pipelines, and retrieve artifacts via REST API.
Beta: The API is currently in beta. Available on Pro plan and above. Endpoints and response formats may change.
Base URL
https://api.zephly.ai/v1Authentication
API Keys — Coming Soon. API key generation is not yet available. Currently, authentication is handled via session tokens only. API key support will be added in a future release.
curl -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
https://api.zephly.ai/v1/workflowsEndpoints overview
| Method | Endpoint | Description |
|---|---|---|
| GET | /workflows | List your workflows |
| POST | /workflows | Create a workflow |
| GET | /workflows/:id | Get workflow details |
| POST | /workflows/:id/execute | Execute a workflow |
| GET | /workflows/:id/runs | List execution history |
| GET | /artifacts/:id | Download an artifact |
| GET | /me | Current user profile |
| GET | /credits | Credit balance |
In this section
- Authentication — API keys, JWT tokens, OAuth
- Workflows — CRUD operations and execution
- Webhooks — trigger workflows from external events
Interactive docs
For the complete OpenAPI spec with try-it-now functionality, visit the Swagger UI at /api/docs (requires authentication).
Last updated: 2026-03-27