GET https://api.zatomic.ai/v1/projects
POST https://api.zatomic.ai/v1/projects
GET https://api.zatomic.ai/v1/projects/{promptId}
PATCH https://api.zatomic.ai/v1/projects/{promptId}
DELETE https://api.zatomic.ai/v1/projects/{promptId}
Zatomic API
- Overview
- Versioning
- Authentication
- Workspaces
- Status Codes and Errors
- Token Usage
- Expanding Objects
- OpenAPI Spec
- Changelog
- Projects
- The Project Object
- Create Project
- Update Project
- Delete Project
- Retrieve Project
- Retrieve All Projects
- Prompts
- The Prompt Object
- Create Prompt
- Update Prompt
- Delete Prompt
- Retrieve Prompt
- Retrieve All Prompts
- Generate Prompt
- Versions
- The Version Object
- Create Version
- Update Version
- Delete Version
- Retrieve Version
- Retrieve All Versions
- Calculate Version Score
- Retrieve Version Score
- Generate Version Heatmap
- Retrieve Version Heatmap
- Analyze Version Balance
- Retrieve Version Balance
- Analyze Version Risk
- Retrieve Version Risk
- Improve Version
- Scoring Criteria
- The Scoring Criteria Object
- The Scoring Criterion Object
- Create Scoring Criteria
- Update Scoring Criteria
- Delete Scoring Criteria
- Retrieve Scoring Criteria
- Retrieve All Scoring Criteria
- Generate Scoring Criteria
- Create Scoring Criterion
- Update Scoring Criterion
- Delete Scoring Criterion
- Retrieve Scoring Criterion
- Scoring Criteria Results
- The Scoring Criteria Results Object
- Scoring
- The Scoring Object
- Calculate Prompt Score
- Heatmaps
- The Heatmap Object
- Generate Prompt Heatmap
- Balance
- The Balance Object
- Analyze Prompt Balance
- Risk
- The Risk Object
- Analyze Prompt Risk
Projects
Projects provide an additional layer of organization for your prompts; you can think of them like folders. Projects are workspace-specific, but you can create as many projects as needed in each workspace. You can also add any number of prompts to each project.
Projects can be expanded to include all of their prompts, prompt versions, as well as the scoring, risk, balance, and heatmap for each version.
Expands | |
---|---|
prompts | Retrieves all prompts for the project. |
versions | Retrieves all versions for each prompt in the project. |
scoring | Retrieves the scoring object for each version of each prompt in the project. |
heatmap | Retrieves the heatmap object for each version of each prompt in the project. |
balance | Retrieves the balance object for each version of each prompt in the project. |
risk | Retrieves the risk object for each version of each prompt in the project. |
Endpoints