Skip to content
ACS Infra
Looms

Get Loom

GET
/v1/looms/{loom_id}

Return the Loom: each Node with its status and text. Read it again to follow a Branch.

Authorization

bearer
headerAuthorizationBearer <token>

An API key: Authorization: Bearer sk-acs-..., or a key of the old platform, acs-bm-.... A User makes and revokes keys in the App.

Path Parameters

loom_id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$
Formatuuid

Response Body

Loom

application/json
  1. response
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$
Formatuuid
object*"loom"
Value in"loom"
created_at*integer

When the Loom was made, in Unix seconds.

title*string

The Loom's name. Empty until its first Branch names it after the first line of its root, or a rename names it.

pinned*boolean

A pinned Loom comes first in the list.

nodes*array<>

Depth first from each root: each Node comes after its parent and before its next sibling, and siblings come in the order they were made.

Example Request
curl -X GET 'https://api.v2.infra.acsresearch.org/v1/looms/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Authorization: Bearer <API_KEY>'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "loom",  "created_at": 0,  "title": "string",  "pinned": true,  "nodes": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "loom.node",      "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",      "status": "queued",      "text": "string",      "logprobs": {        "text_offset": [          0        ],        "token_logprobs": [          0        ],        "tokens": [          "string"        ],        "top_logprobs": [          {            "property1": 0,            "property2": 0          }        ]      },      "error": {        "message": "string",        "type": "string",        "param": "string",        "code": "string",        "retryable": true,        "retry_after_seconds": 0,        "upstream_status": 0,        "request_id": "string"      },      "request": {        "model": "string",        "max_tokens": 32000,        "temperature": 0,        "logprobs": 0,        "top_p": 0,        "top_k": 0,        "min_p": 0,        "presence_penalty": 0,        "frequency_penalty": 0,        "repetition_penalty": 0,        "seed": 0,        "stop": "string"      }    }  ]}

Export Loom GET

Download the Loom as a file in Production's export shape (version 2): its title and last Branch settings, and each Node with its settings and marks, parents first. POST /v1/looms/import makes a Loom from it.

Update Loom POST

Rename or pin the Loom, and answer it. A rename moves it to the top of its unpinned Looms; a pin puts it above them.