{
"version_id": "ctv_2qRzu8qzlNOMhTrini2EKCDh5r6",
"context_id": "ctx_2qRzu8geIvfudcJTwP0pur4TbMJ",
"created": "2024-12-19T20:33:16.076891Z",
"updated": "2024-12-19T20:39:13.026997Z",
"is_primary": true,
"is_locked": false,
"locked_by": null,
"name": null,
"type": "file",
"file_name": "file.md",
"file_size_in_bytes": 17824,
"file_download_url": "https://download-url"
}
API Reference
- Overview
- Versioning
- Authentication
- Workspaces
- Status Codes and Errors
- Credit Usage
- Expanding Objects
- OpenAPI Spec
- Changelog
- Contexts
- The Context Object
- Create File Context
- Create Text Context
- Update Context
- Delete Context
- Retrieve Context
- Retrieve All Contexts
- Context Versions
- The Context Version Object
- Create File Context Version
- Create Text Context Version
- Update File Context Version
- Update Text Context Version
- Delete Context Version
- Retrieve Context Version
- Retrieve All Context Versions
- 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
The Context Version Object
| Properties | |
|---|---|
|
version_id
string
|
Unique ID of the context version. |
|
context_id
string
|
The ID of the parent context. |
|
created
datetime
|
UTC timestamp for when the context version was created. |
|
updated
datetime
|
UTC timestamp for when the context version was updated. |
|
is_primary
boolean
|
Indicates if the context version is the primary version for the context. |
|
is_locked
boolean
|
Indicates if the context version is locked. |
|
locked_by
string, nullable
|
The name of the user who locked the context version. |
|
name
string, nullable
|
Name of the context version. |
|
type
string
|
The type of context version, either file or text. |
|
content
string, nullable
|
The content of the context version. Applies only to context versions of type text. |
|
file_name
string, nullable
|
The file name for the context version. Applies only to context versions of type file. |
|
file_size_in_bytes
integer, nullable
|
The file size in bytes for the context version. Applies only to context versions of type file. |
|
file_download_url
string, nullable
|
The download URL for the context version file. Applies only to context versions of type file. |
The File Context Version Object - Fully Expanded
The Text Context Version Object - Fully Expanded
{
"version_id": "ctv_2qRzu8qzlNOMhTrini2EKCDh5r6",
"context_id": "ctx_2qRzu8geIvfudcJTwP0pur4TbMJ",
"created": "2024-12-19T20:33:16.076891Z",
"updated": "2024-12-19T20:39:13.026997Z",
"is_primary": true,
"is_locked": false,
"locked_by": null,
"name": null,
"type": "text",
"content": "This is a reusable piece of text."
}