Skip to content
ACS Infra
Looms

Export Loom

GET
/v1/looms/{loom_id}/export

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.

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

LoomFile

application/json
  1. response
version?unknown

The file's version, 2. Production's export writes it; the API does not keep it.

node_order?unknown

How the Nodes are ordered. Production's export writes it; the API does not keep it.

loom?

The Loom's title and last settings.

nodes*array<>

At most 2000 Nodes, each with a unique id. A Node whose parent is not in the file goes under the file's root when it has one root, else it is a root; a cycle is broken at a Node that becomes a root.

Itemsitems <= 2000
Example Request
curl -X GET 'https://api.v2.infra.acsresearch.org/v1/looms/497f6eca-6276-4993-bfeb-53cbbbba6f08/export' \  -H 'Authorization: Bearer <API_KEY>'
Example Response
{  "version": null,  "node_order": null,  "loom": {    "title": "string",    "model": null,    "last_generation_config": null  },  "nodes": [    {      "id": "string",      "parent_id": "string",      "text": "string",      "status": "completed",      "position": 0,      "model": "string",      "seed": 0,      "generation_config": {},      "logprobs": [        {          "token": "string",          "logprob": 0,          "top": [            {              "token": "string",              "logprob": 0            }          ]        }      ],      "error": null,      "generation_id": null,      "choice_index": null,      "created_at": null,      "finish_reason": null,      "stop_reason": null,      "n_tokens": null,      "usage_source": null,      "api_key_id": null    }  ]}

Import Loom POST

Make a Loom from a file that GET /v1/looms/{loom_id}/export or Production's Loom export wrote, and answer it. Its Nodes get new ids; a Node keeps its text, its status (none is `completed`), its log probabilities and the Branch options it ran with.

Get Loom GET

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