Notes¶
13 endpoints. Every path below is served by workspace-backend behind the gateway at https://api.trilocore.ai.
POST /api/v1/workspaces/notes/images¶
Upload Image
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 201 |
| Upstream | workspace-backend |
Request body
multipart/form-data:image(a file,image/png, image/jpeg, image/gif, image/webp, required)
multipart/form-data with one file part image: image/png, image/jpeg, image/gif, image/webp; at most 8388608 bytes. Another part type is 415, a larger part 413, an empty one 422, a missing one 422.
DELETE /api/v1/workspaces/notes/images/{uuid}¶
Delete Image
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 204 |
| Upstream | workspace-backend |
GET /api/v1/workspaces/notes/images/{uuid}¶
Get Image
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 200 |
| Upstream | workspace-backend |
GET /api/v1/workspaces/notes/spaces¶
List Spaces
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 200 |
| Upstream | workspace-backend |
| Pagination | paged: page_size ≤ 200 (default 50) + page_token; the body is {data, has_more, next_page_token, page_size} |
Query parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
page_size |
integer | no | default 50, clamped to 200, minimum 1 |
Items per page. Default 50; values above 200 are clamped to 200 (never an error). The effective value is echoed as page_size. |
page_token |
string | no | maxLength 2048 |
Opaque token from a previous page's next_page_token. Valid for 3 days, only with the same filters and the same caller. Omit it to start from the first page. |
▶ Run this example in the sandbox
POST /api/v1/workspaces/notes/spaces¶
Create Space
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 201 |
| Upstream | workspace-backend |
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
kind |
one of | no | — |
name |
string | yes | maxLength 200, minLength 1 |
project_id |
one of | no | — |
workspace_id |
one of | no | — |
▶ Run this example in the sandbox
GET /api/v1/workspaces/notes/spaces/{id}/entries¶
List Entries
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 200 |
| Upstream | workspace-backend |
| Pagination | paged: page_size ≤ 200 (default 50) + page_token; the body is {data, has_more, next_page_token, page_size} |
Query parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
page_size |
integer | no | default 50, clamped to 200, minimum 1 |
Items per page. Default 50; values above 200 are clamped to 200 (never an error). The effective value is echoed as page_size. |
page_token |
string | no | maxLength 2048 |
Opaque token from a previous page's next_page_token. Valid for 3 days, only with the same filters and the same caller. Omit it to start from the first page. |
project_id |
string | no | maxLength 64 |
— |
▶ Run this example in the sandbox
POST /api/v1/workspaces/notes/spaces/{id}/entries¶
Create Entry
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 201 |
| Upstream | workspace-backend |
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
assignee_user_id |
one of | no | — |
body |
string | no | maxLength 1048576 |
finding_ref |
one of | no | — |
kind |
string | no | maxLength 40 |
project_id |
one of | no | — |
severity |
one of | no | — |
title |
one of | no | — |
▶ Run this example in the sandbox
DELETE /api/v1/workspaces/notes/spaces/{id}/entries/{uuid}¶
Delete Entry
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 204 |
| Upstream | workspace-backend |
GET /api/v1/workspaces/notes/spaces/{id}/entries/{uuid}¶
Get Entry
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 200 |
| Upstream | workspace-backend |
▶ Run this example in the sandbox
PATCH /api/v1/workspaces/notes/spaces/{id}/entries/{uuid}¶
Update Entry
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 200 |
| Upstream | workspace-backend |
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
assignee_user_id |
one of | no | — |
body |
one of | no | — |
comment |
one of | no | — |
project_id |
one of | no | — |
severity |
one of | no | — |
status |
one of | no | — |
title |
one of | no | — |
version |
one of | no | — |
▶ Run this example in the sandbox
GET /api/v1/workspaces/notes/spaces/{id}/entries/{uuid}/comments¶
List Comments
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 200 |
| Upstream | workspace-backend |
| Pagination | paged: page_size ≤ 200 (default 50) + page_token; the body is {data, has_more, next_page_token, page_size} |
Query parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
page_size |
integer | no | default 50, clamped to 200, minimum 1 |
Items per page. Default 50; values above 200 are clamped to 200 (never an error). The effective value is echoed as page_size. |
page_token |
string | no | maxLength 2048 |
Opaque token from a previous page's next_page_token. Valid for 3 days, only with the same filters and the same caller. Omit it to start from the first page. |
▶ Run this example in the sandbox
POST /api/v1/workspaces/notes/spaces/{id}/entries/{uuid}/comments¶
Add Comment
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 201 |
| Upstream | workspace-backend |
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
body |
string | yes | maxLength 65536, minLength 1 |
▶ Run this example in the sandbox
GET /api/v1/workspaces/notes/spaces/{id}/events¶
List Events
| Property | Value |
|---|---|
| Authentication | Authorization: Bearer (jns_ key or SSO session) |
| Idempotency-Key | not required |
| Success | 200 |
| Upstream | workspace-backend |
Query parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
after |
integer | no | minimum 0 |
— |
limit |
integer | no | minimum 1 |
Events per poll. Values above 500 are clamped to 500 (never an error). |