Zatomic
Zatomic API

Improving a version

Creates a new version of the prompt based on either its scoring analysis or risk analysis. A successful call returns a response that contains the newly improved version object.

The request supports a source value, which determines if the improvement will be based on the prompt's scoring analysis or its risk analysis.

You can also add a settings object to the request that specifies which AI model and provider you want to use to improve the prompt. If settings is given in the request, the model_source and model_id are required.

The model_source field specifies where the model comes from. When using models from your own AI providers, use the value provider; otherwise, use zatomic.

If provider_id is given and the provider is for Amazon Bedrock, then the aws_region is required and must be the region where the model is located.

You can find model IDs in the model catalog and provider IDs in your Zatomic account.

Endpoint 
POST https://api.zatomic.ai/v1/prompts/{promptId}/versions/{versionId}/improve

// Example
POST https://api.zatomic.ai/v1/prompts/prm_2qRzu8geIvfudcJTwP0pur4TbMJ/versions/ver_2qRzu8qzlNOMhTrini2EKCDh5r6/improve
Request Properties
source
string, optional
 The analysis source for the improvement. If given must be scoring or risk. If not given defaults to scoring.
settings
object, optional

Properties for the object:

model_source
string
 The source of the model.
model_id
string
 The ID of the AI model to use for the improvement.
provider_id
string, optional
 The ID of the AI provider that contains the model to use for the improvement.
aws_region
string, optional
 The AWS region where the model resides. Required if the given provider is Amazon Bedrock.
Request Body 
{
   "source": "scoring|risk",
   "settings": {
      "model_source": "zatomic|provider",
      "model_id": "aim_2y2eRWI32fN0CB7a5wE7RuvhVMv"
      "provider_id": "aap_2zFxUYe3RINnOr37VQwHDFF3gK3",
      "aws_region": "us-east-1"
   }
}