{
"context_id": "ctx_2qRzu8geIvfudcJTwP0pur4TbMJ",
"workspace_id": "wrk_2nKxr84BuEQIpUl3evP3XYyTxdo",
"project_id": "prj_32Tk7u9OX9HN7AUXm3EjJKRJ5yD",
"created": "2024-12-19T20:33:15.7387Z",
"updated": "2024-12-19T20:33:15.971617Z",
"name": "File context name",
"type": "file",
"description": "File context description",
"versions": [
{
"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 Object
| Properties | |
|---|---|
|
context_id
string
|
Unique ID of the context. |
|
workspace_id
string
|
The ID of the workspace that contains the context. |
|
project_id
string, nullable
|
The ID of the project that contains the context. |
|
created
datetime
|
UTC timestamp for when the context was created. |
|
updated
datetime
|
UTC timestamp for when the context was updated. |
|
name
string
|
Name of the context. |
|
type
string
|
The type of context, either file or text. |
|
description
string, nullable
|
Description of the context. |
|
versions
list of version objects
|
List of versions for the context; can be empty. If the context has versions, by default the list will include only the context's primary version. If the versions expand is used, the list will include all versions for the context. |
The File Context Object - Fully Expanded
The Text Context Object - Fully Expanded
{
"context_id": "ctx_2qRzu8geIvfudcJTwP0pur4TbMJ",
"workspace_id": "wrk_2nKxr84BuEQIpUl3evP3XYyTxdo",
"project_id": "prj_32Tk7u9OX9HN7AUXm3EjJKRJ5yD",
"created": "2024-12-19T20:33:15.7387Z",
"updated": "2024-12-19T20:33:15.971617Z",
"name": "Text context name",
"type": "text",
"description": "Text context description",
"versions": [
{
"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."
}
]
}