API Documentation
Ace API
Comprehensive guide to the Ace AI API endpoints
This documentation is actively being updated as we further develop our API.
Welcome to the Ace API
The Ace AI API allows developers to interact with AI-related services to:- Generate synthetic data.
- Upload and download datasets using signed URLs.
- Perform specific tasks with custom AI prompts.
- (Planned) Perform data refinement and other advanced data tasks.
All data will be subject to scrutiny from our team of domain-expert human evaluators.
Core Functionality
The Ace AI API is organized into several key sections:- Authentication: Sign up, log in, and manage your user profile.
- Synthetic Data: Upload original datasets, generate synthetic data, and download the results.
- Generative AI (GenAI): Upload data for custom AI tasks and retrieve analytical results.
- Evaluator: Retrieve, create, and update evaluation data, as well as manage comments on evaluation entries.
- Editor: Retrieve, create, and update editing tasks for enhanced data processing.
Authentication
Authentication is the foundation of our API. The following endpoints help you register, log in, and manage your profile:- POST
/auth/v1/signup: Register a new user account. - POST
/auth/v1/login: Log in and receive a session token (returned as both an HttpOnly cookie and a Bearer token). - PATCH
/auth/v1/profile/{username}: Update your user profile with expertise, bio, education, and experiences.
Base Endpoints
Below is a quick list of the core API endpoints. For complete details—including request parameters, response formats, and usage examples—please refer to the dedicated pages in the Endpoints section.| Route | Method | Description |
|---|---|---|
/ | GET | Default route. Returns “hello world!” as a simple health check. |
/auth/v1/signup | POST | Registers a new user account. |
/auth/v1/login | POST | Authenticates a user and returns a session token. |
/auth/v1/profile/{username} | PATCH | Updates a user profile. |
/synthetic/v1/uploadURL | POST | Generates a signed URL for securely uploading datasets. |
/synthetic/v1/downloadURL | POST | Generates a signed URL for securely downloading data. |
/synthetic/v1/generate | POST | Requests the creation of synthetic data based on an existing dataset. |
/genAI/v1/uploadURL | POST | Generates a signed URL for uploading data for GenAI tasks. |
/genAI/v1/downloadURL | POST | Generates a signed URL for downloading data used or produced by GenAI tasks. |
/genAI/v1/perform | POST | Submits a custom prompt for AI-based analysis of uploaded data. |
/evaluator/v1/evaluation-data | GET | Retrieves evaluation data with filtering options (username, status, etc.). |
/evaluator/v1/evaluation-data | POST | Creates a new evaluation data entry. |
/evaluator/v1/evaluation-data/random | GET | Retrieves a random evaluation data entry based on evaluator username. |
/evaluator/v1/evaluation-data/{id} | PATCH | Updates evaluation data fields (tags, status, data, rating) for an entry. |
/evaluator/v1/evaluation-data/comment | GET | Retrieves comments for a specific evaluation data entry. |
/evaluator/v1/evaluation-data/comment | POST | Adds a new comment to an evaluation data entry. |
/evaluator/v1/evaluation-data/comment/{id} | PATCH | Updates an existing comment on an evaluation data entry. |
/evaluator/v1/evaluation-data/comment/{id} | DELETE | Deletes a comment from an evaluation data entry. |
/editor/v1/tasks/random | GET | Retrieves a random editing task for a specified task type. |
/editor/v1/tasks/{taskType} | POST | Creates a new editing task of the specified type. |
/editor/v1/tasks/{taskType}/{id} | PATCH | Updates an existing editing task. |
This introduction provides a high-level overview of the API, its capabilities, and how to get started. For detailed information about each endpoint—including request parameters, response formats, and examples—please see the dedicated pages in the Endpoints section.