GET https://api.zatomic.ai/v1/prompts
// Examples
GET https://api.zatomic.ai/v1/prompts?expand=versions
GET https://api.zatomic.ai/v1/prompts?expand=scoring
GET https://api.zatomic.ai/v1/prompts?expand=risk
GET https://api.zatomic.ai/v1/prompts?expand=balance
GET https://api.zatomic.ai/v1/prompts?expand=heatmap
Zatomic API
- Introduction
- Versioning
- Authentication
- Workspaces
- Status codes and errors
- Token usage
- Expanding objects
- OpenAPI spec
- Prompts
- The Prompt object
- Creating a prompt
- Updating a prompt
- Deleting a prompt
- Retrieving a prompt
- Retrieving all prompts
- Generating a prompt
- Versions
- The Version object
- Creating a version
- Updating a version
- Deleting a version
- Retrieving a version
- Retrieving all versions
- Retrieving a version score
- Calculating a version score
- Retrieving a version risk
- Analyzing a version risk
- Retrieving a version balance
- Analyzing a version balance
- Retrieving a version heatmap
- Generating a version heatmap
- Improving a version
- Scoring Criteria
- The Scoring Criteria object
- The Scoring Criterion object
- Creating scoring criteria
- Updating a scoring criteria
- Deleting a scoring criteria
- Retrieving a scoring criteria
- Retrieving all scoring criteria
- Generating scoring criteria
- Creating a scoring criterion
- Updating a scoring criterion
- Deleting a scoring criterion
- Retrieving a scoring criterion
- Scoring Criteria Results
- The Scoring Criteria Results object
- Scoring
- The Scoring object
- Calculating a prompt score
- Risk
- The Risk object
- Analyzing prompt risk
- Balance
- The Balance object
- Analyzing prompt balance
- Heatmaps
- The Heatmap object
- Generating a prompt heatmap
Retrieving all prompts
Returns the list of all prompts in a given workspace, sorted alphabetically by prompt name.
A successful call returns a response that contains a list of prompt objects.
Expands | |
---|---|
versions | Retrieves all versions of each prompt in the list. |
scoring | Retrieves the scoring object for each version of each prompt in the list. |
risk | Retrieves the risk object for each version of each prompt in the list. |
balance | Retrieves the balance object for each version of each prompt in the list. |
heatmap | Retrieves the heatmap object for each version of each prompt in the list. |
Endpoint
Response Body
[
{
"prompt_id": "prm_2qJhUNbuEg3J8dvw39jgL3UEJKS",
"workspace_id": "wrk_2nKxr84BuEQIpUl3evP3XYyTxdo",
"created": "2024-12-16T22:03:19.30308Z",
"created_by": "Han Solo",
"updated": "2024-12-16T22:03:19.568618Z",
"updated_by": "Han Solo",
"name": "Prompt name",
"use_case": "Use case description.",
"versions": []
}
]