Register Artifact | BCTRL Docs

curl -X POST https://api.bctrl.ai/v1/runs/id/artifacts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "kind": "log-file"
}'

{
  "contentType": "text/plain",
  "createdAt": "2024-06-01T12:00:00Z",
  "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": "7e57d004-2b97-0e7a-b45f-5387367791cd",
  "kind": "log-file",
  "name": "run-1234-log.txt",
  "path": "/artifacts/run-1234/logs/run-1234-log.txt",
  "runId": "1c6b147e-3f4a-4d2a-9f3e-8a1b2c3d4e5f",
  "runtimeId": "9f8e7d6c-5b4a-3c2d-1e0f-123456789abc",
  "runtimeKind": "browser",
  "sizeBytes": 2048,
  "downloadUrl": "https://storage.bctrl.ai/files/3fa85f64-5717-4562-b3fc-2c963f66afa6/download"
}

Attach an existing space storage file to a run as an artifact. Use this when external tools or uploads produce a file that belongs in run outputs.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

fileIdstringRequiredformat: "uuid"

kindstringRequired1-64 characters

metadataobjectOptional

namestringOptional1-255 characters

Response

Default Response

contentTypestring>=1 character

createdAtstring

fileIdstringformat: "uuid"

idstringformat: "uuid"

kindstring>=1 character

namestring>=1 character

pathstring>=1 character

runIdstringformat: "uuid"

runtimeIdstringformat: "uuid"

runtimeKindenum

Allowed values:

sizeBytesinteger0-9007199254740991

downloadUrlstring