GET https://api.zatomic.ai/v1/projects/{projectId}
// Examples
GET https://api.zatomic.ai/v1/projects/prj_32hbc9w4iVeyUZ1iRvjZYUrvS73
GET https://api.zatomic.ai/v1/projects/prj_32hbc9w4iVeyUZ1iRvjZYUrvS73?expand=prompts
GET https://api.zatomic.ai/v1/projects/prj_32hbc9w4iVeyUZ1iRvjZYUrvS73?expand=versions
GET https://api.zatomic.ai/v1/projects/prj_32hbc9w4iVeyUZ1iRvjZYUrvS73?expand=scoring
GET https://api.zatomic.ai/v1/projects/prj_32hbc9w4iVeyUZ1iRvjZYUrvS73?expand=heatmap
GET https://api.zatomic.ai/v1/projects/prj_32hbc9w4iVeyUZ1iRvjZYUrvS73?expand=balance
GET https://api.zatomic.ai/v1/projects/prj_32hbc9w4iVeyUZ1iRvjZYUrvS73?expand=risk
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
Retrieve Project
Retrieves a project from the given workspace.
| 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. |
Endpoint
Endpoint Response
A successful call returns a response that contains the project object.
| HTTP Status Codes | ||
|---|---|---|
| 200 | OK | The project was retrieved. |
| 404 | Not Found | The project didn't exist. |
| 500 | Internal Server Error | Something went wrong on Zatomic's end. |