Reads one workspace item. A folder returns its direct children; a text document returns its text a page at a time (pass nextOffset as offset for the rest); another uploaded file returns its name, type, size and download URL; an image, video or audio item returns its asset, shaped like GET /assets/{assetId}. Only item is returned when the backing record is gone. Addresses the item by its path; /workspace/nodes/{nodeId} does the same by id. Uses the processes:read scope.
Authorization
bearerAuth processes:readIn: header
Scope: processes:read
Path Parameters
Query Parameters
Absolute workspace path, such as /Characters/hero. Names match exactly first, then ignoring case.
1 <= length <= 4000Text documents only: the character to start at (nextOffset from the previous read).
0 <= value0Text documents only: characters to return.
1 <= value <= 10000020000Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/sessions/string/workspace/nodes?path=%2FCharacters%2Fhero"{ "item": { "id": "string", "parentId": "string", "name": "string", "path": "/Characters/hero", "type": "folder", "kind": "folder", "assetId": "string", "previewUrl": "http://example.com", "note": "string", "pinned": true, "selected": true, "brief": true, "color": "string", "semantic": "string", "childCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "children": [ { "id": "string", "parentId": "string", "name": "string", "path": "/Characters/hero", "type": "folder", "kind": "folder", "assetId": "string", "previewUrl": "http://example.com", "note": "string", "pinned": true, "selected": true, "brief": true, "color": "string", "semantic": "string", "childCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "document": { "format": "markdown", "content": "string", "offset": 0, "totalCharacters": 0, "nextOffset": 0 }, "file": { "name": "string", "mimeType": "string", "byteSize": 0, "url": "http://example.com" }, "asset": { "id": "string", "type": "image", "name": "string", "url": "http://example.com", "thumbnailUrl": "http://example.com", "preview": { "url": "http://example.com", "width": 0, "height": 0, "mimeType": "string" }, "width": 0, "height": 0, "duration": 0, "mimeType": "string", "source": "string", "sourceProcessId": "string", "trainingId": "string", "draft": { "finishableUntil": "2019-08-24T14:15:22Z" }, "favorite": true, "sessionId": "string", "createdAt": "2019-08-24T14:15:22Z", "links": { "self": "string" } }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}Read a workspace item GET
Reads one workspace item. A folder returns its direct children; a text document returns its text a page at a time (pass nextOffset as offset for the rest); another uploaded file returns its name, type, size and download URL; an image, video or audio item returns its asset, shaped like GET /assets/{assetId}. Only item is returned when the backing record is gone. Uses the processes:read scope.
Import an asset POST
Imports an external image, video, or audio URL into the team asset library (e.g. before starting a process). Pass sessionId to create it inside a session. Importing an image the team already imported (identical file) returns that existing asset, with its original name, instead of a copy; with sessionId it is added to the session. Spends no credits. Download failures return 400 with code import_failed.