import requests
url = "https://platform.ankra.app/api/v1/org/canvases"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/canvases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/canvases \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "dashboard",
"title": "<string>",
"visibility": "private",
"owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_owner": true,
"is_pinned": true,
"language": "json",
"draft_revision_id": "<string>",
"published_revision_id": "<string>",
"source_conversation_id": "<string>",
"source_artifact_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"reason": "<string>",
"code": "<string>",
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}List canvases
Lists the canvases the caller can see - their own and every canvas shared with the organisation - most recently updated first, without content. query matches the title, kind is dashboard or page, and pinned=true keeps the caller’s pinned canvases. Pass next_cursor back as cursor for the next page. With source_conversation_id and source_artifact_id the list is a lookup instead: items holds the one canvas saved from that chat artifact when the caller can see it, or is empty, and next_cursor is null.
import requests
url = "https://platform.ankra.app/api/v1/org/canvases"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/org/canvases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/org/canvases \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "dashboard",
"title": "<string>",
"visibility": "private",
"owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_owner": true,
"is_pinned": true,
"language": "json",
"draft_revision_id": "<string>",
"published_revision_id": "<string>",
"source_conversation_id": "<string>",
"source_artifact_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"reason": "<string>",
"code": "<string>",
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The next_cursor of the previous page.
1 <= x <= 100Case-insensitive text the title contains.
200dashboard, page With source_artifact_id, looks up the one canvas saved from that chat artifact. Give both or neither; the pair cannot be combined with cursor, query, kind or pinned.
128With source_conversation_id, looks up the one canvas saved from that chat artifact.
128