API Reference

The Context Item Version Object

Properties
version_id
string
Unique ID of the version.
context_item_id
string
The ID of the parent context item.
created
datetime
UTC timestamp for when the version was created.
updated
datetime
UTC timestamp for when the version was updated.
is_primary
boolean
Indicates if the version is the primary version for the context item.
is_locked
boolean
Indicates if the version is locked.
locked_by
string, nullable
The name of the user who locked the version.
name
string, nullable
Name of the version.
type
string
The type of version, either file or text.
content
string, nullable
The content of the version. Applies only to versions of type text.
file_name
string, nullable
The file name for the version. Applies only to versions of type file.
file_size_in_bytes
integer, nullable
The file size in bytes for the version. Applies only to versions of type file.
file_download_url
string, nullable
The download URL for the version file. Applies only to versions of type file.
The File Context Item Version Object - Fully Expanded
{
   "version_id": "ctv_2qRzu8qzlNOMhTrini2EKCDh5r6",
   "context_item_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"
}

The Text Context Item Version Object - Fully Expanded
{
   "version_id": "ctv_2qRzu8qzlNOMhTrini2EKCDh5r6",
   "context_item_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."
}