Zatomic
API Reference

The Prompt Object

Properties
prompt_id
string
 Unique ID of the prompt.
workspace_id
string
 The ID of the workspace that contains the prompt.
project_id
string, nullable
 The ID of the project that contains the prompt.
created
datetime
 UTC timestamp for when the prompt was created.
created_by
string
 The name of the user who created the prompt or the name of the API key that created the prompt.
updated
datetime
 UTC timestamp for when the prompt was updated.
updated_by
string
 The name of the user who updated the prompt or the name of the API key that updated the prompt.
name
string
 Name of the prompt.
use_case
string, nullable
 Use case description for the prompt.
versions
list of version objects
 List of versions for the prompt; can be empty. If the prompt has versions, by default the list will include only the prompt's primary version. If the versions expand is used, the list will include all versions for the prompt.
The Prompt Object - Fully Expanded 
{
   "prompt_id": "prm_2qRzu8geIvfudcJTwP0pur4TbMJ",
   "workspace_id": "wrk_2nKxr84BuEQIpUl3evP3XYyTxdo",
   "project_id": "prj_32Tk7u9OX9HN7AUXm3EjJKRJ5yD",
   "created": "2024-12-19T20:33:15.7387Z",
   "created_by": "Han Solo",
   "updated": "2024-12-19T20:33:15.971617Z",
   "updated_by": "Han Solo",
   "name": "Prompt name",
   "use_case": "Use case description.",
   "versions": [
      {
         "version_id": "ver_2qRzu8qzlNOMhTrini2EKCDh5r6",
         "prompt_id": "prm_2qRzu8geIvfudcJTwP0pur4TbMJ",
         "created": "2024-12-19T20:33:16.076891Z",
         "created_by": "Han Solo",
         "updated": "2024-12-19T20:39:13.026997Z",
         "updated_by": "Han Solo",
         "is_locked": false,
         "locked_by": null,
         "name": null,
         "is_primary": true,
         "content": "You are a knowledgeable and friendly assistant...",
         "variables": [
            "{{variable1}}",
            "[[variable2]]"
         ],
         "token_info": {
            "model": "gpt-5.2",
            "token_count": 0,
            "cost_per_use": 0.0,
            "cost_per_1k": 0.0,
            "cost_per_1m": 0.0
         },
         "scoring": {
            "version_timestamp": "2024-12-19T20:33:15.971617Z",
            "scoring_timestamp": "2024-12-19T20:33:15.971617Z",
            "overall_score": 0,
            "rating": "Excellent",
            "summary": {
               "strengths": "The strengths of the prompt.",
               "areas_for_improvement": "Areas where the prompt could improve.",
               "overall_feedback": "Overall feedback for the prompt."
            },
            "criteria": {
               "criteria_id": "sca_2rjp9HFpIsiYQrAiSbZlz85r3GC",
               "name": "Default",
               "criterion_results": [
                  {
                     "slug": "criterion_slug",
                     "score": 0,
                     "weight": 0,
                     "weighted_score": 0,
                     "feedback": "Specific feedback for the criterion."
                  }
               ]
            }
         },
         "heatmap": {
            "version_timestamp": "2024-12-19T20:33:15.971617Z",
            "heatmap_timestamp": "2024-12-19T20:33:15.971617Z",
            "summary": "Summary of the heatmap.",
            "phrases": [
               {
                  "phrase": "The prompt phrase.",
                  "attention_score": 1,
                  "color": "The color level assigned to the phrase.",
                  "reason": "The reason why the AI model assigned the phrase its attention score."
               }
            ]
         },
         "balance": {
            "version_timestamp": "2024-12-19T20:33:15.971617Z",
            "balance_timestamp": "2024-12-19T20:33:15.971617Z",
            "summary": {
               "overall_feedback": "Overall feedback based on the prompt balance.",
               "recommendations": "Recommendations to improve the prompt balance."
            },
            "categories": [
               {
                  "category": "The category name,",
                  "feedback": "Feedback about the balance of the category in the prompt.",
                  "phrase_count": 0,
                  "phrase_percent": 0.0,
                  "distribution": "The category distribution."
               }
            ],
            "phrases": [
               {
                  "phrase": "The prompt phrase.",
                  "category": "The prompt category.",
                  "reason": "Reason the phrase was assigned to its category."
               }
            ]
         },
         "risk": {
            "version_timestamp": "2025-06-22T14:45:19.144393Z",
            "risk_timestamp": "2025-06-22T18:52:20.1727176Z",
            "summary": {
               "overall_feedback": "Overall feedback for the risk analysis.",
               "overall_risk_level": "low|medium|high"
            },
            "bias_analysis": {
               "risk_level": "low|medium|high",
               "feedback": "Feedback for the bias analysis.",
               "issues": [
                  {
                     "issue": "Potential bias.",
                     "parts": [
                        {
                           "part": "Affected part of the prompt.",
                           "revision": "Suggested revision for the prompt part."
                        }
                     ]
                  }
               ]
            },
            "ethical_analysis": {
               "risk_level": "low|medium|high",
               "feedback": "Feedback for the ethical analysis.",
               "issues": [
                  {
                     "issue": "Ethical concern.",
                     "parts": [
                        {
                           "part": "Affected part of the prompt.",
                           "revision": "Suggested revision for the prompt part."
                        }
                     ]
                  }
               ]
            },
            "safety_analysis": {
               "risk_level": "low|medium|high",
               "feedback": "Feedback for the safety analysis.",
               "issues": [
                  {
                     "issue": "Safety issue.",
                     "parts": [
                        {
                           "part": "Affected part of the prompt.",
                           "revision": "Suggested revision for the prompt part."
                        }
                     ]
                  }
               ]
            }
         }
      }
   ]
}