API Reference
Welcome to the Lumea API Reference. This section provides comprehensive documentation for using Lumea's RESTful APIs to integrate with our platform.
Overview
Lumea provides a set of powerful APIs that allow you to programmatically create, manage, and monitor agentic AI workflows. Our APIs are designed to be:
- RESTful - Following standard REST principles for predictable behavior
- Secure - Using industry-standard authentication and authorization mechanisms
- Reliable - Built for stability and performance at scale
- Well-documented - With clear examples and guides
API Sections
Our API is organized into the following main sections:
- Authentication - Authenticate and secure your API requests
- Workflows - Create, manage, and monitor AI workflows
- Runs - Execute and manage individual workflow runs
- Users - Manage user accounts and permissions
- Evaluations - Run and manage evaluations for your workflows
- Costs - Track and analyze costs of your AI operations
- Batches - Manage batch operations for your workflows
- Artifacts - Store and retrieve data artifacts from your workflows
Custom Deployment Endpoints
Each customer receives a custom deployment with a unique API endpoint. The base URL for your API requests will be provided during onboarding. All endpoints documented in this reference should be prefixed with your organization's specific API URL.
For example, if your custom API endpoint is https://acme-corp.lumea.ai, then the workflows endpoint would be:
https://acme-corp.lumea.ai/workflowsAPI Versioning
Our API uses versioning to ensure compatibility as we add new features. The current version is v1. The version is included in your custom API endpoint.
Need Help?
If you encounter any issues or have questions about the API, please contact our support team.