Cortex API reference
Use the Cortex API to work with Modules, Flashes, Issues, and their related resources. This reference is generated from the contract used by the Cortex service and TypeScript client.
Send a Socra access token as a Bearer token in the Authorization header. All methods use JSON unless the method has no request or response body.
Bash
curl https://cortex.socra.cloud/v1/modules \
--header "Authorization: Bearer $SOCRA_ACCESS_TOKEN"
The contract below is the source of truth for method paths, inputs, outputs, and required authorization scopes.
Base URL
https://cortex.socra.cloudModules
A context module — a self-contained unit of specific knowledge, addressed by name within an account.
Create module
POST
https://cortex.socra.cloud/v1/modulesRequest body
6 fields
6 fields
namestringrequiredcontentstringrequireddependenciesstring[]optionalvisibility"internal" | "private"optionalparentstring | nulloptionalinherit_permissionsbooleanoptionalResponse
13 fields
13 fields
idunknownrequirednamestringrequiredcontentstringrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991archivedbooleanrequiredvisibility"internal" | "private"requireddependenciesstring[]requiredownerstringrequireddefault_assigneestring | nullrequiredparentstring | nullrequiredinherit_permissionsbooleanrequiredcreated_atunknownrequiredupdated_atunknownrequiredList modules
GET
https://cortex.socra.cloud/v1/modulesQuery parameters
5 fields
5 fields
qstringoptionalownerstringoptionalstate"active" | "archived" | "all"optionallimitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequirednamestringrequiredcontentstringrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991archivedbooleanrequiredvisibility"internal" | "private"requireddependenciesstring[]requiredownerstringrequireddefault_assigneestring | nullrequiredparentstring | nullrequiredinherit_permissionsbooleanrequiredcreated_atunknownrequiredupdated_atunknownrequiredhas_morebooleanrequiredGet module
GET
https://cortex.socra.cloud/v1/modules/{name}Path parameters
namestringrequiredQuery parameters
No query parameters
Response
13 fields
13 fields
idunknownrequirednamestringrequiredcontentstringrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991archivedbooleanrequiredvisibility"internal" | "private"requireddependenciesstring[]requiredownerstringrequireddefault_assigneestring | nullrequiredparentstring | nullrequiredinherit_permissionsbooleanrequiredcreated_atunknownrequiredupdated_atunknownrequiredUpdate module
PATCH
https://cortex.socra.cloud/v1/modules/{name}Path parameters
namestringrequiredRequest body
8 fields
8 fields
namestringoptionalcontentstringoptionaldependenciesstring[]optionalvisibility"internal" | "private"optionalownerstringoptionaldefault_assigneestring | nulloptionalparentstring | nulloptionalinherit_permissionsbooleanoptionalResponse
13 fields
13 fields
idunknownrequirednamestringrequiredcontentstringrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991archivedbooleanrequiredvisibility"internal" | "private"requireddependenciesstring[]requiredownerstringrequireddefault_assigneestring | nullrequiredparentstring | nullrequiredinherit_permissionsbooleanrequiredcreated_atunknownrequiredupdated_atunknownrequiredList module versions
GET
https://cortex.socra.cloud/v1/modules/{name}/versionsPath parameters
namestringrequiredQuery parameters
2 fields
2 fields
limitintegeroptionalmin: 1 · max: 100afterintegeroptionalgreater than: 0 · max: 9007199254740991Response
2 fields
2 fields
dataobject[]required
dataobject[]requiredmodule_idunknownrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991namestringrequiredcontentstringrequireddependenciesstring[]requiredownerstringrequireddefault_assigneestring | nullrequiredvisibility"internal" | "private"requiredauthorstring | nullrequiredsource"create" | "update" | "backfill"requiredchanged_fields"name" | "content" | "dependencies" | "owner" | "default_assignee" | "visibility"[]requiredcreated_atunknownrequiredhas_morebooleanrequiredGet module version
GET
https://cortex.socra.cloud/v1/modules/{name}/versions/{version}Path parameters
namestringrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991Query parameters
No query parameters
Response
12 fields
12 fields
module_idunknownrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991namestringrequiredcontentstringrequireddependenciesstring[]requiredownerstringrequireddefault_assigneestring | nullrequiredvisibility"internal" | "private"requiredauthorstring | nullrequiredsource"create" | "update" | "backfill"requiredchanged_fields"name" | "content" | "dependencies" | "owner" | "default_assignee" | "visibility"[]requiredcreated_atunknownrequiredArchive module
POST
https://cortex.socra.cloud/v1/modules/{name}/archivePath parameters
namestringrequiredRequest body
No request body
Response
13 fields
13 fields
idunknownrequirednamestringrequiredcontentstringrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991archivedbooleanrequiredvisibility"internal" | "private"requireddependenciesstring[]requiredownerstringrequireddefault_assigneestring | nullrequiredparentstring | nullrequiredinherit_permissionsbooleanrequiredcreated_atunknownrequiredupdated_atunknownrequiredRestore module
POST
https://cortex.socra.cloud/v1/modules/{name}/restorePath parameters
namestringrequiredRequest body
No request body
Response
13 fields
13 fields
idunknownrequirednamestringrequiredcontentstringrequiredversionintegerrequiredgreater than: 0 · max: 9007199254740991archivedbooleanrequiredvisibility"internal" | "private"requireddependenciesstring[]requiredownerstringrequireddefault_assigneestring | nullrequiredparentstring | nullrequiredinherit_permissionsbooleanrequiredcreated_atunknownrequiredupdated_atunknownrequiredDelete module
DELETE
https://cortex.socra.cloud/v1/modules/{name}Path parameters
namestringrequiredQuery parameters
No query parameters
Response
No response body
Module graph
POST
https://cortex.socra.cloud/v1/modules/graphRequest body
No request body
Response
1 field
1 field
nodesobject[]required
nodesobject[]requirednamestringrequiredsummarystringrequiredownerstringrequiredvisibility"internal" | "private"requiredparentstring | nullrequireddepends_onstring[]requiredModule permissions
The effective permission policy projected through a Cortex module.
Get module permissions
GET
https://cortex.socra.cloud/v1/modules/{name}/permissionsPath parameters
namestringrequiredQuery parameters
No query parameters
Response
4 fields
4 fields
inheritedbooleanrequiredinherited_fromstring | nullrequiredetagstringrequiredbindingsobject[]required
bindingsobject[]requiredrole"admin" | "editor" | "commenter" | "viewer"requiredmembersobject[]requiredmin items: 1Set module permissions
PATCH
https://cortex.socra.cloud/v1/modules/{name}/permissionsPath parameters
namestringrequiredRequest body
2 fields
2 fields
etagstringrequiredmin length: 1bindingsobject[]required
bindingsobject[]requiredrole"admin" | "editor" | "commenter" | "viewer"requiredmembersobject[]requiredmin items: 1Response
4 fields
4 fields
inheritedbooleanrequiredinherited_fromstring | nullrequiredetagstringrequiredbindingsobject[]required
bindingsobject[]requiredrole"admin" | "editor" | "commenter" | "viewer"requiredmembersobject[]requiredmin items: 1Flashes
A flash — one assembly of a target module's dependency closure into a single context bundle. The metered consume verb of Cortex.
Flash a module
POST
https://cortex.socra.cloud/v1/flashesRequest body
1 field
1 field
targetstringrequiredResponse
7 fields
7 fields
idunknownrequiredtargetstringrequiredtotal_tokensnumberrequiredmodule_countnumberrequiredlinesobject[]required
linesobject[]requiredmodulestringrequiredversioninteger | nullrequiredtokensnumberrequiredis_targetbooleanrequiredcreated_atunknownrequiredassemblyobjectrequired
assemblyobjectrequiredtargetstringrequiredmodulesobject[]required
modulesobject[]requirednamestringrequiredcontentstringrequireddepends_onstring[]requiredList flashes
GET
https://cortex.socra.cloud/v1/flashesQuery parameters
3 fields
3 fields
targetstringoptionallimitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequiredtargetstringrequiredtotal_tokensnumberrequiredmodule_countnumberrequiredlinesobject[]required
linesobject[]requiredmodulestringrequiredversioninteger | nullrequiredtokensnumberrequiredis_targetbooleanrequiredcreated_atunknownrequiredhas_morebooleanrequiredGet a flash
GET
https://cortex.socra.cloud/v1/flashes/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
6 fields
6 fields
idunknownrequiredtargetstringrequiredtotal_tokensnumberrequiredmodule_countnumberrequiredlinesobject[]required
linesobject[]requiredmodulestringrequiredversioninteger | nullrequiredtokensnumberrequiredis_targetbooleanrequiredcreated_atunknownrequiredGet a flash assembly
GET
https://cortex.socra.cloud/v1/flashes/{id}/assemblyPath parameters
idunknownrequiredQuery parameters
No query parameters
Response
2 fields
2 fields
targetstringrequiredmodulesobject[]required
modulesobject[]requirednamestringrequiredcontentstringrequireddepends_onstring[]requiredFlash usage
POST
https://cortex.socra.cloud/v1/flashes/usageRequest body
4 fields
4 fields
sinceunknownoptionaluntilunknownoptionalsort"flashed" | "pulled" | "tokens"optionalgroup_by"day" | "module_day"optionalResponse
5 fields
5 fields
total_flashesnumberrequiredtotal_tokensnumberrequiredmodulesobject[]required
modulesobject[]requiredmodulestringrequiredexplicit_flashesnumberrequiredtransitive_pullsnumberrequiredtotal_tokensnumberrequiredlast_flashed_atunknown | nullrequiredper_dayobject[]optional
per_dayobject[]optionaldatestringrequiredflashesnumberrequiredtokensnumberrequiredpullsnumberrequiredmodule_dailyobject[]optional
module_dailyobject[]optionalmodulestringrequiredpointsobject[]required
pointsobject[]requireddatestringrequiredflashesnumberrequiredIssues
A unit of work in flight, owned by a module — the work supply chain over an account’s knowledge.
Create issue
POST
https://cortex.socra.cloud/v1/issuesRequest body
7 fields
7 fields
modulestringrequiredtitlestringrequireddescriptionstringrequiredassigneestring | nulloptionalpriority"low" | "medium" | "high" | "urgent" | nulloptionaldependenciesstring[]optionallabelsstring[]optionalResponse
14 fields
14 fields
idunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredstatus"open" | "in_progress" | "done" | "canceled"requiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredoriginatorstringrequiredassigneestring | nullrequireddependenciesstring[]requiredlabelsobject[]required
labelsobject[]requiredidunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredschedulestring | nullrequiredscheduled_forunknown | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredList issues
GET
https://cortex.socra.cloud/v1/issuesQuery parameters
7 fields
7 fields
modulestringoptionalstatus"open" | "in_progress" | "done" | "canceled"optionalassigneestringoptionallabelstringoptionalqstringoptionallimitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredstatus"open" | "in_progress" | "done" | "canceled"requiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredoriginatorstringrequiredassigneestring | nullrequireddependenciesstring[]requiredlabelsobject[]required
labelsobject[]requiredidunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredschedulestring | nullrequiredscheduled_forunknown | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredhas_morebooleanrequiredIssue inbox
POST
https://cortex.socra.cloud/v1/issues/inboxRequest body
2 fields
2 fields
limitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredstatus"open" | "in_progress" | "done" | "canceled"requiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredoriginatorstringrequiredassigneestring | nullrequireddependenciesstring[]requiredlabelsobject[]required
labelsobject[]requiredidunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredschedulestring | nullrequiredscheduled_forunknown | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredhas_morebooleanrequiredGet issue
GET
https://cortex.socra.cloud/v1/issues/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
14 fields
14 fields
idunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredstatus"open" | "in_progress" | "done" | "canceled"requiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredoriginatorstringrequiredassigneestring | nullrequireddependenciesstring[]requiredlabelsobject[]required
labelsobject[]requiredidunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredschedulestring | nullrequiredscheduled_forunknown | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredUpdate issue
PATCH
https://cortex.socra.cloud/v1/issues/{id}Path parameters
idunknownrequiredRequest body
7 fields
7 fields
titlestringoptionaldescriptionstringoptionalstatus"open" | "in_progress" | "done" | "canceled"optionalassigneestring | nulloptionalpriority"low" | "medium" | "high" | "urgent" | nulloptionaldependenciesstring[]optionallabelsstring[]optionalResponse
14 fields
14 fields
idunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredstatus"open" | "in_progress" | "done" | "canceled"requiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredoriginatorstringrequiredassigneestring | nullrequireddependenciesstring[]requiredlabelsobject[]required
labelsobject[]requiredidunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredschedulestring | nullrequiredscheduled_forunknown | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredDelete issue
DELETE
https://cortex.socra.cloud/v1/issues/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
No response body
Labels
An account-scoped classification that can be attached to Cortex issues.
Create label
POST
https://cortex.socra.cloud/v1/labelsRequest body
2 fields
2 fields
namestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nulloptionalResponse
5 fields
5 fields
idunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredList labels
GET
https://cortex.socra.cloud/v1/labelsQuery parameters
4 fields
4 fields
namestringoptionalmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$qstringoptionallimitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredhas_morebooleanrequiredGet label
GET
https://cortex.socra.cloud/v1/labels/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
5 fields
5 fields
idunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredUpdate label
PATCH
https://cortex.socra.cloud/v1/labels/{id}Path parameters
idunknownrequiredRequest body
2 fields
2 fields
namestringoptionalmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nulloptionalResponse
5 fields
5 fields
idunknownrequirednamestringrequiredmin length: 1 · max length: 40 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$colorstring | nullrequiredcreated_atunknownrequiredupdated_atunknownrequiredDelete label
DELETE
https://cortex.socra.cloud/v1/labels/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
No response body
Issue schedules
A durable recurrence rule that materializes ordinary Cortex issues.
Create issue schedule
POST
https://cortex.socra.cloud/v1/issue-schedulesRequest body
9 fields
9 fields
modulestringrequiredtitlestringrequiredmin length: 1descriptionstringrequiredpriority"low" | "medium" | "high" | "urgent" | nulloptionalassigneestring | nulloptionalcronstringrequiredmin length: 1timezonestringrequiredmin length: 1overlap_policy"coalesce" | "allow"requiredmissed_run_policy"next_only" | "catch_up"requiredResponse
15 fields
15 fields
idunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredassigneestring | nullrequiredcronstringrequiredtimezonestringrequiredoverlap_policy"coalesce" | "allow"requiredmissed_run_policy"next_only" | "catch_up"requiredenabledbooleanrequirednext_run_atunknownrequiredcreated_bystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredList issue schedules
GET
https://cortex.socra.cloud/v1/issue-schedulesQuery parameters
4 fields
4 fields
modulestringoptionalenabledunknownoptionallimitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredassigneestring | nullrequiredcronstringrequiredtimezonestringrequiredoverlap_policy"coalesce" | "allow"requiredmissed_run_policy"next_only" | "catch_up"requiredenabledbooleanrequirednext_run_atunknownrequiredcreated_bystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredhas_morebooleanrequiredGet issue schedule
GET
https://cortex.socra.cloud/v1/issue-schedules/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
15 fields
15 fields
idunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredassigneestring | nullrequiredcronstringrequiredtimezonestringrequiredoverlap_policy"coalesce" | "allow"requiredmissed_run_policy"next_only" | "catch_up"requiredenabledbooleanrequirednext_run_atunknownrequiredcreated_bystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredUpdate issue schedule
PATCH
https://cortex.socra.cloud/v1/issue-schedules/{id}Path parameters
idunknownrequiredRequest body
9 fields
9 fields
titlestringoptionalmin length: 1descriptionstringoptionalpriority"low" | "medium" | "high" | "urgent" | nulloptionalassigneestring | nulloptionalcronstringoptionalmin length: 1timezonestringoptionalmin length: 1overlap_policy"coalesce" | "allow"optionalmissed_run_policy"next_only" | "catch_up"optionalenabledbooleanoptionalResponse
15 fields
15 fields
idunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredassigneestring | nullrequiredcronstringrequiredtimezonestringrequiredoverlap_policy"coalesce" | "allow"requiredmissed_run_policy"next_only" | "catch_up"requiredenabledbooleanrequirednext_run_atunknownrequiredcreated_bystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredDelete issue schedule
DELETE
https://cortex.socra.cloud/v1/issue-schedules/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
No response body
Queue an immediate issue schedule run
POST
https://cortex.socra.cloud/v1/issue-schedules/{id}/runPath parameters
idunknownrequiredRequest body
No request body
Response
15 fields
15 fields
idunknownrequiredmodulestringrequiredtitlestringrequireddescriptionstringrequiredpriority"low" | "medium" | "high" | "urgent" | nullrequiredassigneestring | nullrequiredcronstringrequiredtimezonestringrequiredoverlap_policy"coalesce" | "allow"requiredmissed_run_policy"next_only" | "catch_up"requiredenabledbooleanrequirednext_run_atunknownrequiredcreated_bystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredComments
An authored note on an issue — the issue's own progress narrative.
Create comment
POST
https://cortex.socra.cloud/v1/commentsRequest body
3 fields
3 fields
issuestringrequiredThe issue id, e.g. issue_…
bodystringrequiredattachmentsstring[]optionalmax items: 20Response
6 fields
6 fields
idunknownrequiredissueunknownrequiredauthorstringrequiredbodystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredList comments
GET
https://cortex.socra.cloud/v1/commentsQuery parameters
3 fields
3 fields
issuestringrequiredThe issue id, e.g. issue_…
limitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequiredissueunknownrequiredauthorstringrequiredbodystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredhas_morebooleanrequiredGet comment
GET
https://cortex.socra.cloud/v1/comments/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
6 fields
6 fields
idunknownrequiredissueunknownrequiredauthorstringrequiredbodystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredUpdate comment
PATCH
https://cortex.socra.cloud/v1/comments/{id}Path parameters
idunknownrequiredRequest body
1 field
1 field
bodystringrequiredResponse
6 fields
6 fields
idunknownrequiredissueunknownrequiredauthorstringrequiredbodystringrequiredcreated_atunknownrequiredupdated_atunknownrequiredDelete comment
DELETE
https://cortex.socra.cloud/v1/comments/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
No response body
Issue attachments
A private file owned by an issue and authorized through its module.
Prepare issue attachment upload
POST
https://cortex.socra.cloud/v1/issue-attachmentsRequest body
5 fields
5 fields
issuestringrequiredThe issue id, e.g. issue_…
filenamestringrequiredmin length: 1 · max length: 255media_typestringrequiredmin length: 1 · max length: 255 · pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$byte_sizeintegerrequiredgreater than: 0 · max: 26214400checksum_sha256stringrequiredpattern: ^[A-Za-z0-9+/]{43}=$Response
2 fields
2 fields
attachmentobjectrequired
attachmentobjectrequiredidunknownrequiredissueunknownrequiredfilenamestringrequiredmedia_typestringrequiredbyte_sizeintegerrequiredmin: 0 · max: 9007199254740991checksum_sha256stringrequiredstate"pending" | "ready"requireduploaded_bystringrequiredcommentsunknown[]requireduploaded_atunknown | nullrequireddeleted_atunknown | nullrequiredcreated_atunknownrequireduploadobjectrequired
uploadobjectrequiredurlstringrequiredformat: urimethod"PUT"requiredheadersobjectrequiredexpires_atunknownrequiredList issue attachments
GET
https://cortex.socra.cloud/v1/issue-attachmentsQuery parameters
3 fields
3 fields
issuestringrequiredThe issue id, e.g. issue_…
limitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequiredissueunknownrequiredfilenamestringrequiredmedia_typestringrequiredbyte_sizeintegerrequiredmin: 0 · max: 9007199254740991checksum_sha256stringrequiredstate"pending" | "ready"requireduploaded_bystringrequiredcommentsunknown[]requireduploaded_atunknown | nullrequireddeleted_atunknown | nullrequiredcreated_atunknownrequiredhas_morebooleanrequiredGet issue attachment
GET
https://cortex.socra.cloud/v1/issue-attachments/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
12 fields
12 fields
idunknownrequiredissueunknownrequiredfilenamestringrequiredmedia_typestringrequiredbyte_sizeintegerrequiredmin: 0 · max: 9007199254740991checksum_sha256stringrequiredstate"pending" | "ready"requireduploaded_bystringrequiredcommentsunknown[]requireduploaded_atunknown | nullrequireddeleted_atunknown | nullrequiredcreated_atunknownrequiredComplete issue attachment upload
POST
https://cortex.socra.cloud/v1/issue-attachments/{id}/completePath parameters
idunknownrequiredRequest body
No request body
Response
12 fields
12 fields
idunknownrequiredissueunknownrequiredfilenamestringrequiredmedia_typestringrequiredbyte_sizeintegerrequiredmin: 0 · max: 9007199254740991checksum_sha256stringrequiredstate"pending" | "ready"requireduploaded_bystringrequiredcommentsunknown[]requireduploaded_atunknown | nullrequireddeleted_atunknown | nullrequiredcreated_atunknownrequiredGet issue attachment download
POST
https://cortex.socra.cloud/v1/issue-attachments/{id}/downloadPath parameters
idunknownrequiredRequest body
No request body
Response
2 fields
2 fields
urlstringrequiredformat: uriexpires_atunknownrequiredRemove issue attachment
DELETE
https://cortex.socra.cloud/v1/issue-attachments/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
No response body
Comment attachments
A placement of an issue-owned attachment in an authored issue comment.
Place attachment in comment
POST
https://cortex.socra.cloud/v1/comment-attachmentsRequest body
3 fields
3 fields
commentstringrequiredThe comment id, e.g. comment_…
attachmentstringrequiredThe issue attachment id, e.g. issue_attachment_…
positionintegeroptionalmin: 0 · max: 9007199254740991Response
6 fields
6 fields
idunknownrequiredissueunknownrequiredcommentunknownrequiredattachmentobjectrequired
attachmentobjectrequiredidunknownrequiredissueunknownrequiredfilenamestringrequiredmedia_typestringrequiredbyte_sizeintegerrequiredmin: 0 · max: 9007199254740991checksum_sha256stringrequiredstate"pending" | "ready"requireduploaded_bystringrequiredcommentsunknown[]requireduploaded_atunknown | nullrequireddeleted_atunknown | nullrequiredcreated_atunknownrequiredpositionintegerrequiredmin: 0 · max: 9007199254740991created_atunknownrequiredList comment attachments
GET
https://cortex.socra.cloud/v1/comment-attachmentsQuery parameters
2 fields
2 fields
commentstringoptionalThe comment id, e.g. comment_…
issuestringoptionalThe issue id, e.g. issue_…
Response
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequiredissueunknownrequiredcommentunknownrequiredattachmentobjectrequired
attachmentobjectrequiredidunknownrequiredissueunknownrequiredfilenamestringrequiredmedia_typestringrequiredbyte_sizeintegerrequiredmin: 0 · max: 9007199254740991checksum_sha256stringrequiredstate"pending" | "ready"requireduploaded_bystringrequiredcommentsunknown[]requireduploaded_atunknown | nullrequireddeleted_atunknown | nullrequiredcreated_atunknownrequiredpositionintegerrequiredmin: 0 · max: 9007199254740991created_atunknownrequiredhas_morefalserequiredRemove attachment from comment
DELETE
https://cortex.socra.cloud/v1/comment-attachments/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
No response body
Issue events
An immutable record of a state change to an issue — its timeline.
List issue events
GET
https://cortex.socra.cloud/v1/issue-eventsQuery parameters
3 fields
3 fields
issuestringrequiredThe issue id, e.g. issue_…
limitintegeroptionalmin: 1 · max: 100afterstringoptionalResponse
2 fields
2 fields
dataobject[]required
dataobject[]requiredidunknownrequiredissueunknownrequiredactorstringrequiredtype"created" | "status_changed" | "assigned" | "prioritized" | "retitled" | "redescribed" | "dependencies_changed" | "labels_changed"requireddataobjectrequiredcreated_atunknownrequiredhas_morebooleanrequiredGet issue event
GET
https://cortex.socra.cloud/v1/issue-events/{id}Path parameters
idunknownrequiredQuery parameters
No query parameters
Response
6 fields
6 fields
idunknownrequiredissueunknownrequiredactorstringrequiredtype"created" | "status_changed" | "assigned" | "prioritized" | "retitled" | "redescribed" | "dependencies_changed" | "labels_changed"requireddataobjectrequiredcreated_atunknownrequired