Trylle Documentation

listCIJobs

List recent trylle-ci jobs for a repository.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

owner*string

Repository owner login.

Length1 <= length

repo*string

Repository name.

Length1 <= length

limit?integer

Maximum jobs to return. Defaults to 50.

Formatint64

Range1 <= value <= 200

Default50

Response Body

`application/json`

curl -X GET "https://example.com/v1/ci/jobs?owner=aa&repo=aa&limit=2"

{  "count": 1,  "jobs": [    {      "artifactUrls": {        "abc123": "abc123"      },      "artifacts": [        {          "contentType": "abc123",          "name": "aa",          "path": "aa",          "sizeBytes": 1,          "url": "aa"        }      ],      "createdAt": "abc123",      "error": "abc123",      "exitCode": 1,      "finishedAt": "abc123",      "idempotencyKey": "abc123",      "outputs": {        "abc123": "abc123"      },      "request": {        "actor": {          "avatarUrl": "abc123",          "id": 1,          "login": "aa"        },        "artifactPaths": [          "abc123"        ],        "env": {          "abc123": "abc123"        },        "eventName": "aa",        "eventPayload": "abc123",        "idempotencyKey": "abc123",        "jobId": "abc123",        "matrix": {          "abc123": "abc123"        },        "ref": "abc123",        "refType": "tag",        "repository": {          "cloneUrl": "abc123",          "defaultBranch": "abc123",          "id": "abc123",          "name": "aa",          "owner": "aa"        },        "runnerArch": "abc123",        "sha": "abc123",        "templateId": "abc123",        "timeoutSeconds": 1,        "workflowContent": "abc123",        "workflowFiles": {          "abc123": "abc123"        },        "workflowInputs": {          "abc123": "abc123"        },        "workflowPath": "aa"      },      "runId": "aa",      "runnerArch": "abc123",      "sandboxId": "abc123",      "startedAt": "abc123",      "status": "running",      "updatedAt": "abc123",      "usage": {        "archiveBytes": 1,        "artifactBytes": 1,        "cancelledCount": 1,        "failedCount": 1,        "jobCount": 1,        "logBytes": 1,        "queueSeconds": 1,        "queuedCount": 1,        "runningCount": 1,        "sandboxSeconds": 1,        "skippedCount": 1,        "succeededCount": 1,        "wallClockSeconds": 1      }    }  ]}

createCIJob

Schedule a GitHub Actions-compatible CI job through trylle-ci.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

artifactPaths?array<string>

Sandbox file or directory paths to snapshot and archive after the run.

env?

Extra environment variables passed to the sandbox.

eventName*string

GitHub Actions event name, e.g. push or workflow_dispatch.

Length1 <= length

eventPayload?unknown

Event payload exposed to the runner.

idempotencyKey?string

Optional caller-supplied dedupe key.

jobId?string

Optional workflow jobs. to run. Defaults to the first job in workflow order.

Length1 <= length

matrix?

Matrix context for a single matrix job shard.

ref?string

Git ref for the run.

refType?string

Git ref kind for the run when ref is supplied.

Value in

"branch"
"tag"

repository*

sha?string

Git commit SHA for the run.

templateId?string

Optional E2B/Cube template override.

timeoutSeconds?integer

Sandbox lifetime and command timeout in seconds.

Formatint64

Range1 <= value <= 86400

workflowFiles?

Optional workflow file map keyed by repository path, used to resolve local reusable workflows.

workflowInputs?

Workflow dispatch or workflow_call inputs exposed through the Actions inputs context.

workflowPath*string

Workflow YAML path, e.g. .github/workflows/ci.yml.

Length1 <= length

workflowYaml?string

Optional raw workflow YAML. When omitted, platform-api loads workflowPath from the repository when possible.

Response Body

`application/json`

curl -X POST "https://example.com/v1/ci/jobs" \  -H "Content-Type: application/json" \  -d '{    "artifactPaths": [      "abc123"    ],    "env": {      "abc123": "abc123"    },    "eventName": "aa",    "eventPayload": "abc123",    "idempotencyKey": "abc123",    "jobId": "aa",    "matrix": {      "abc123": "abc123"    },    "ref": "abc123",    "refType": "tag",    "repository": {      "cloneUrl": "abc123",      "defaultBranch": "abc123",      "id": "abc123",      "name": "aa",      "owner": "aa"    },    "sha": "abc123",    "templateId": "abc123",    "timeoutSeconds": 2,    "workflowFiles": {      "abc123": "abc123"    },    "workflowInputs": {      "abc123": "abc123"    },    "workflowPath": "aa",    "workflowYaml": "abc123"  }'

{  "artifactUrls": {    "abc123": "abc123"  },  "artifacts": [    {      "contentType": "abc123",      "name": "aa",      "path": "aa",      "sizeBytes": 1,      "url": "aa"    }  ],  "createdAt": "abc123",  "error": "abc123",  "exitCode": 1,  "finishedAt": "abc123",  "idempotencyKey": "abc123",  "outputs": {    "abc123": "abc123"  },  "request": {    "actor": {      "avatarUrl": "abc123",      "id": 1,      "login": "aa"    },    "artifactPaths": [      "abc123"    ],    "env": {      "abc123": "abc123"    },    "eventName": "aa",    "eventPayload": "abc123",    "idempotencyKey": "abc123",    "jobId": "abc123",    "matrix": {      "abc123": "abc123"    },    "ref": "abc123",    "refType": "tag",    "repository": {      "cloneUrl": "abc123",      "defaultBranch": "abc123",      "id": "abc123",      "name": "aa",      "owner": "aa"    },    "runnerArch": "abc123",    "sha": "abc123",    "templateId": "abc123",    "timeoutSeconds": 1,    "workflowContent": "abc123",    "workflowFiles": {      "abc123": "abc123"    },    "workflowInputs": {      "abc123": "abc123"    },    "workflowPath": "aa"  },  "runId": "aa",  "runnerArch": "abc123",  "sandboxId": "abc123",  "startedAt": "abc123",  "status": "running",  "updatedAt": "abc123",  "usage": {    "archiveBytes": 1,    "artifactBytes": 1,    "cancelledCount": 1,    "failedCount": 1,    "jobCount": 1,    "logBytes": 1,    "queueSeconds": 1,    "queuedCount": 1,    "runningCount": 1,    "sandboxSeconds": 1,    "skippedCount": 1,    "succeededCount": 1,    "wallClockSeconds": 1  }}

getCIJob

Fetch a trylle-ci job by run id.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

runId*string

CI run id.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/ci/jobs/aa"

{  "artifactUrls": {    "abc123": "abc123"  },  "artifacts": [    {      "contentType": "abc123",      "name": "aa",      "path": "aa",      "sizeBytes": 1,      "url": "aa"    }  ],  "createdAt": "abc123",  "error": "abc123",  "exitCode": 1,  "finishedAt": "abc123",  "idempotencyKey": "abc123",  "outputs": {    "abc123": "abc123"  },  "request": {    "actor": {      "avatarUrl": "abc123",      "id": 1,      "login": "aa"    },    "artifactPaths": [      "abc123"    ],    "env": {      "abc123": "abc123"    },    "eventName": "aa",    "eventPayload": "abc123",    "idempotencyKey": "abc123",    "jobId": "abc123",    "matrix": {      "abc123": "abc123"    },    "ref": "abc123",    "refType": "tag",    "repository": {      "cloneUrl": "abc123",      "defaultBranch": "abc123",      "id": "abc123",      "name": "aa",      "owner": "aa"    },    "runnerArch": "abc123",    "sha": "abc123",    "templateId": "abc123",    "timeoutSeconds": 1,    "workflowContent": "abc123",    "workflowFiles": {      "abc123": "abc123"    },    "workflowInputs": {      "abc123": "abc123"    },    "workflowPath": "aa"  },  "runId": "aa",  "runnerArch": "abc123",  "sandboxId": "abc123",  "startedAt": "abc123",  "status": "running",  "updatedAt": "abc123",  "usage": {    "archiveBytes": 1,    "artifactBytes": 1,    "cancelledCount": 1,    "failedCount": 1,    "jobCount": 1,    "logBytes": 1,    "queueSeconds": 1,    "queuedCount": 1,    "runningCount": 1,    "sandboxSeconds": 1,    "skippedCount": 1,    "succeededCount": 1,    "wallClockSeconds": 1  }}

cancelCIJob

Cancel a queued or running trylle-ci job.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

runId*string

CI run id.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/v1/ci/jobs/aa/cancel"

{  "artifactUrls": {    "abc123": "abc123"  },  "artifacts": [    {      "contentType": "abc123",      "name": "aa",      "path": "aa",      "sizeBytes": 1,      "url": "aa"    }  ],  "createdAt": "abc123",  "error": "abc123",  "exitCode": 1,  "finishedAt": "abc123",  "idempotencyKey": "abc123",  "outputs": {    "abc123": "abc123"  },  "request": {    "actor": {      "avatarUrl": "abc123",      "id": 1,      "login": "aa"    },    "artifactPaths": [      "abc123"    ],    "env": {      "abc123": "abc123"    },    "eventName": "aa",    "eventPayload": "abc123",    "idempotencyKey": "abc123",    "jobId": "abc123",    "matrix": {      "abc123": "abc123"    },    "ref": "abc123",    "refType": "tag",    "repository": {      "cloneUrl": "abc123",      "defaultBranch": "abc123",      "id": "abc123",      "name": "aa",      "owner": "aa"    },    "runnerArch": "abc123",    "sha": "abc123",    "templateId": "abc123",    "timeoutSeconds": 1,    "workflowContent": "abc123",    "workflowFiles": {      "abc123": "abc123"    },    "workflowInputs": {      "abc123": "abc123"    },    "workflowPath": "aa"  },  "runId": "aa",  "runnerArch": "abc123",  "sandboxId": "abc123",  "startedAt": "abc123",  "status": "running",  "updatedAt": "abc123",  "usage": {    "archiveBytes": 1,    "artifactBytes": 1,    "cancelledCount": 1,    "failedCount": 1,    "jobCount": 1,    "logBytes": 1,    "queueSeconds": 1,    "queuedCount": 1,    "runningCount": 1,    "sandboxSeconds": 1,    "skippedCount": 1,    "succeededCount": 1,    "wallClockSeconds": 1  }}

getCIJobLogs

Fetch stdout/stderr snapshot and archive URLs for a trylle-ci job.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

runId*string

CI run id.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/ci/jobs/aa/logs"

{  "actionLogs": {    "abc123": "abc123"  },  "artifactUrls": {    "abc123": "abc123"  },  "artifacts": [    {      "contentType": "abc123",      "name": "aa",      "path": "aa",      "sizeBytes": 1,      "url": "aa"    }  ],  "done": false,  "error": "abc123",  "hydrationPending": false,  "runId": "aa",  "status": "running",  "stderr": "abc123",  "stdout": "abc123",  "updatedAt": "abc123",  "usage": {    "archiveBytes": 1,    "artifactBytes": 1,    "cancelledCount": 1,    "failedCount": 1,    "jobCount": 1,    "logBytes": 1,    "queueSeconds": 1,    "queuedCount": 1,    "runningCount": 1,    "sandboxSeconds": 1,    "skippedCount": 1,    "succeededCount": 1,    "wallClockSeconds": 1  }}

getCIUsage

Summarize measured trylle-ci usage for an account or repository.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

owner*string

Repository owner login or organization login.

Length1 <= length

repo?string

Optional repository name. When omitted, usage is summed for the owner.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/ci/usage?owner=aa&repo=aa"

{  "archiveBytes": 1,  "artifactBytes": 1,  "cancelledCount": 1,  "failedCount": 1,  "jobCount": 1,  "logBytes": 1,  "queueSeconds": 1,  "queuedCount": 1,  "runningCount": 1,  "sandboxSeconds": 1,  "skippedCount": 1,  "succeededCount": 1,  "wallClockSeconds": 1}

listCIWorkflowRuns

List recent trylle-ci workflow runs for a repository.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

owner*string

Repository owner login.

Length1 <= length

repo*string

Repository name.

Length1 <= length

page?integer

One-indexed page. Handler clamps values below 1 to 1.

Formatint64

Range1 <= value

Default1

per_page?integer

Items per page. Handler defaults to 30 and clamps above 100.

Formatint64

Range1 <= value <= 100

Default30

cursor?string

Base64 cursor encoding page and per_page; overrides page/per_page when valid.

Response Body

`application/json`

curl -X GET "https://example.com/v1/ci/workflow-runs?owner=aa&repo=aa&page=2&per_page=2&cursor=abc123"

"abc123"

createCIWorkflowRun

Schedule a full GitHub Actions-compatible workflow run through trylle-ci.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

artifactPaths?array<string>

Sandbox file or directory paths to snapshot and archive after each job.

env?

Extra environment variables passed to each sandbox.

eventName*string

GitHub Actions event name, e.g. push or workflow_dispatch.

Length1 <= length

eventPayload?unknown

Event payload exposed to the runner.

idempotencyKey?string

Optional caller-supplied dedupe key.

ref?string

Git ref for the run.

refType?string

Git ref kind for the run when ref is supplied.

Value in

"branch"
"tag"

repository*

sha?string

Git commit SHA for the run.

templateId?string

Optional E2B/Cube template override.

timeoutSeconds?integer

Sandbox lifetime and command timeout in seconds.

Formatint64

Range1 <= value <= 86400

workflowFiles?

Optional workflow file map keyed by repository path, used to resolve local reusable workflows.

workflowInputs?

Workflow dispatch inputs exposed through the Actions inputs context for top-level jobs.

workflowPath*string

Workflow YAML path, e.g. .github/workflows/ci.yml.

Length1 <= length

workflowYaml?string

Optional raw workflow YAML. When omitted, platform-api loads workflowPath from the repository.

Response Body

`application/json`

curl -X POST "https://example.com/v1/ci/workflow-runs" \  -H "Content-Type: application/json" \  -d '{    "artifactPaths": [      "abc123"    ],    "env": {      "abc123": "abc123"    },    "eventName": "aa",    "eventPayload": "abc123",    "idempotencyKey": "abc123",    "ref": "abc123",    "refType": "tag",    "repository": {      "cloneUrl": "abc123",      "defaultBranch": "abc123",      "id": "abc123",      "name": "aa",      "owner": "aa"    },    "sha": "abc123",    "templateId": "abc123",    "timeoutSeconds": 2,    "workflowFiles": {      "abc123": "abc123"    },    "workflowInputs": {      "abc123": "abc123"    },    "workflowPath": "aa",    "workflowYaml": "abc123"  }'

{  "createdAt": "abc123",  "error": "abc123",  "finishedAt": "abc123",  "idempotencyKey": "abc123",  "jobs": [    {      "artifactUrls": {        "abc123": "abc123"      },      "artifacts": [        {          "contentType": "abc123",          "name": "aa",          "path": "aa",          "sizeBytes": 1,          "url": "aa"        }      ],      "error": "abc123",      "exitCode": 1,      "finishedAt": "abc123",      "if": "abc123",      "jobId": "aa",      "key": "aa",      "matrix": {        "abc123": "abc123"      },      "name": "abc123",      "needs": [        "abc123"      ],      "outputs": {        "abc123": "abc123"      },      "runId": "aa",      "runnerArch": "abc123",      "sandboxId": "abc123",      "startedAt": "abc123",      "status": "running",      "usage": {        "archiveBytes": 1,        "artifactBytes": 1,        "cancelledCount": 1,        "failedCount": 1,        "jobCount": 1,        "logBytes": 1,        "queueSeconds": 1,        "queuedCount": 1,        "runningCount": 1,        "sandboxSeconds": 1,        "skippedCount": 1,        "succeededCount": 1,        "wallClockSeconds": 1      }    }  ],  "request": {    "actor": {      "avatarUrl": "abc123",      "id": 1,      "login": "aa"    },    "artifactPaths": [      "abc123"    ],    "env": {      "abc123": "abc123"    },    "eventName": "aa",    "eventPayload": "abc123",    "idempotencyKey": "abc123",    "ref": "abc123",    "refType": "tag",    "repository": {      "cloneUrl": "abc123",      "defaultBranch": "abc123",      "id": "abc123",      "name": "aa",      "owner": "aa"    },    "sha": "abc123",    "templateId": "abc123",    "timeoutSeconds": 1,    "workflowContent": "abc123",    "workflowFiles": {      "abc123": "abc123"    },    "workflowInputs": {      "abc123": "abc123"    },    "workflowPath": "aa"  },  "startedAt": "abc123",  "status": "running",  "updatedAt": "abc123",  "usage": {    "archiveBytes": 1,    "artifactBytes": 1,    "cancelledCount": 1,    "failedCount": 1,    "jobCount": 1,    "logBytes": 1,    "queueSeconds": 1,    "queuedCount": 1,    "runningCount": 1,    "sandboxSeconds": 1,    "skippedCount": 1,    "succeededCount": 1,    "wallClockSeconds": 1  },  "workflowRunId": "aa"}

getCIWorkflowRun

Fetch a trylle-ci workflow run by id.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

workflowRunId*string

CI workflow run id.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/v1/ci/workflow-runs/aa"

{  "createdAt": "abc123",  "error": "abc123",  "finishedAt": "abc123",  "idempotencyKey": "abc123",  "jobs": [    {      "artifactUrls": {        "abc123": "abc123"      },      "artifacts": [        {          "contentType": "abc123",          "name": "aa",          "path": "aa",          "sizeBytes": 1,          "url": "aa"        }      ],      "error": "abc123",      "exitCode": 1,      "finishedAt": "abc123",      "if": "abc123",      "jobId": "aa",      "key": "aa",      "matrix": {        "abc123": "abc123"      },      "name": "abc123",      "needs": [        "abc123"      ],      "outputs": {        "abc123": "abc123"      },      "runId": "aa",      "runnerArch": "abc123",      "sandboxId": "abc123",      "startedAt": "abc123",      "status": "running",      "usage": {        "archiveBytes": 1,        "artifactBytes": 1,        "cancelledCount": 1,        "failedCount": 1,        "jobCount": 1,        "logBytes": 1,        "queueSeconds": 1,        "queuedCount": 1,        "runningCount": 1,        "sandboxSeconds": 1,        "skippedCount": 1,        "succeededCount": 1,        "wallClockSeconds": 1      }    }  ],  "request": {    "actor": {      "avatarUrl": "abc123",      "id": 1,      "login": "aa"    },    "artifactPaths": [      "abc123"    ],    "env": {      "abc123": "abc123"    },    "eventName": "aa",    "eventPayload": "abc123",    "idempotencyKey": "abc123",    "ref": "abc123",    "refType": "tag",    "repository": {      "cloneUrl": "abc123",      "defaultBranch": "abc123",      "id": "abc123",      "name": "aa",      "owner": "aa"    },    "sha": "abc123",    "templateId": "abc123",    "timeoutSeconds": 1,    "workflowContent": "abc123",    "workflowFiles": {      "abc123": "abc123"    },    "workflowInputs": {      "abc123": "abc123"    },    "workflowPath": "aa"  },  "startedAt": "abc123",  "status": "running",  "updatedAt": "abc123",  "usage": {    "archiveBytes": 1,    "artifactBytes": 1,    "cancelledCount": 1,    "failedCount": 1,    "jobCount": 1,    "logBytes": 1,    "queueSeconds": 1,    "queuedCount": 1,    "runningCount": 1,    "sandboxSeconds": 1,    "skippedCount": 1,    "succeededCount": 1,    "wallClockSeconds": 1  },  "workflowRunId": "aa"}

cancelCIWorkflowRun

Cancel a queued or running trylle-ci workflow run and its child jobs.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

workflowRunId*string

CI workflow run id.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/v1/ci/workflow-runs/aa/cancel"

{  "createdAt": "abc123",  "error": "abc123",  "finishedAt": "abc123",  "idempotencyKey": "abc123",  "jobs": [    {      "artifactUrls": {        "abc123": "abc123"      },      "artifacts": [        {          "contentType": "abc123",          "name": "aa",          "path": "aa",          "sizeBytes": 1,          "url": "aa"        }      ],      "error": "abc123",      "exitCode": 1,      "finishedAt": "abc123",      "if": "abc123",      "jobId": "aa",      "key": "aa",      "matrix": {        "abc123": "abc123"      },      "name": "abc123",      "needs": [        "abc123"      ],      "outputs": {        "abc123": "abc123"      },      "runId": "aa",      "runnerArch": "abc123",      "sandboxId": "abc123",      "startedAt": "abc123",      "status": "running",      "usage": {        "archiveBytes": 1,        "artifactBytes": 1,        "cancelledCount": 1,        "failedCount": 1,        "jobCount": 1,        "logBytes": 1,        "queueSeconds": 1,        "queuedCount": 1,        "runningCount": 1,        "sandboxSeconds": 1,        "skippedCount": 1,        "succeededCount": 1,        "wallClockSeconds": 1      }    }  ],  "request": {    "actor": {      "avatarUrl": "abc123",      "id": 1,      "login": "aa"    },    "artifactPaths": [      "abc123"    ],    "env": {      "abc123": "abc123"    },    "eventName": "aa",    "eventPayload": "abc123",    "idempotencyKey": "abc123",    "ref": "abc123",    "refType": "tag",    "repository": {      "cloneUrl": "abc123",      "defaultBranch": "abc123",      "id": "abc123",      "name": "aa",      "owner": "aa"    },    "sha": "abc123",    "templateId": "abc123",    "timeoutSeconds": 1,    "workflowContent": "abc123",    "workflowFiles": {      "abc123": "abc123"    },    "workflowInputs": {      "abc123": "abc123"    },    "workflowPath": "aa"  },  "startedAt": "abc123",  "status": "running",  "updatedAt": "abc123",  "usage": {    "archiveBytes": 1,    "artifactBytes": 1,    "cancelledCount": 1,    "failedCount": 1,    "jobCount": 1,    "logBytes": 1,    "queueSeconds": 1,    "queuedCount": 1,    "runningCount": 1,    "sandboxSeconds": 1,    "skippedCount": 1,    "succeededCount": 1,    "wallClockSeconds": 1  },  "workflowRunId": "aa"}

CI runs

200application/json

202application/json

200application/json

202application/json

200application/json

200application/json

200application/json

202application/json

200application/json

202application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`