// With request headers
curl -X GET https://api.zatomic.ai/v1/prompts \
-H "X-Api-Key: {API key}"
curl -X GET https://api.zatomic.ai/v1/prompts \
-H "X-Api-Key: {API key}" \
-H "X-Api-Client: {API client ID}"
// With querystring parameters
GET https://api.zatomic.ai/v1/prompts?api-key={API key}
GET https://api.zatomic.ai/v1/prompts?api-key={API key}&api-client={API client ID}
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
Authentication
An API key is required to authenticate all requests to the API. You can view and manage your API keys in your Zatomic account.
Authentication to the API is handled by setting the X-Api-Key request header or by using the api-key querystring parameter. If both are given, the api-key querystring parameter will be used.
For authentication, API calls will fail for the following reasons:
- Your API key not being sent in the request.
- Your API key is invalid.
You may also require users of the API to make requests with an API client ID. Similar to an API key, an API client ID is a unique identifier that grants its user access to the API, thus allowing account admins the ability to track who or what is using the API on their behalf.
If API client IDs are required for your account, in addition to your API key, you must make API calls by setting the X-Api-Client request header or by using the api-client querystring parameter. If both are given, the api-client querystring parameter will be used.
If API client IDs are required for your account, API calls will fail for the following reasons:
- The API client ID not being sent in the request.
- The API client ID is invalid.
Requiring API clients for the API is managed in your Zatomic account.
Authenticated Request