A web app link to give the user for a page outside any session: view=elements (the element library; with element, an id or @ID like @hero or @hero:coat-on, that element opens on that image) or view=library (the asset library; with libraryFolderId, filtered to that Library folder). Session pages are GET /sessions/{sessionId}/links. Naming an element or a Library folder needs assets:read.
Authorization
bearerAuth processes:readIn: header
Scope: processes:read
Query Parameters
"elements"Value in
- "elements"
- "library"
view=library only: a Library folder (GET /library/folders) to open filtered to.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/links"{ "view": "elements", "url": "http://example.com", "element": { "id": "string", "tag": "string" }, "libraryFolder": { "id": "string", "name": "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 by path 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. Addresses the item by its path; /workspace/nodes/{nodeId} does the same by id. 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, and libraryFolderId to file it into a Library folder. 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.