Skip to content
Thyme Docs

Executables

List executables

GET/api/v1/executables

Required scope: executables:read.

Query Parameters

projectIdRequired
string
limit
integer·min 1·max 200·default 50
cursor
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Responses

Create executable

POST/api/v1/executables

Required scope: executables:write. Owner/admin membership is required.

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
projectIdRequired
string
functionIdRequired
string
profileIdRequired
string
nameRequired
string
triggerRequired
args
string

JSON-encoded task args. The API does not run all Console JSON/schema validation before storing this value. The task runtime validates args.

secretBindings
object[]

gasMode
string

Available modes depend on the profile kind. Roles profiles require sponsored mode.

Values
sponsoredselfself-funded
gasFallback
boolean
sponsorshipProvider
string

Provider choice for eligible profiles. This field does not select managed Lift sponsorship.

Values
pimlicoalchemy
sandboxRuntime
string

Where the task code runs. Defaults to daytona. gvisor is accepted only on deployments that have a gVisor sandbox runner configured.

Values
daytonagvisor

Responses

Get executable

GET/api/v1/executables/{executableId}

Required scope: executables:read.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Responses

Delete executable

DELETE/api/v1/executables/{executableId}

Delete a non-active executable (paused, provisioning, or error). Active executables must be paused first. Already-deleted executables are rejected. Requires executables:write and owner/admin membership.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Responses

Update executable args

PATCH/api/v1/executables/{executableId}/args

Replace the JSON-encoded task args; function permission coverage is rechecked. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
args
string

JSON-encoded task args. The API does not run all Console JSON/schema validation before storing this value. The task runtime validates args.

Responses

Switch executable function

PATCH/api/v1/executables/{executableId}/function

The executable must be paused. Returns 202 while an atomic sandbox replacement is built. Poll pendingFunctionSwitch and lastFunctionSwitchError. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
functionIdRequired
string
args
string

JSON-encoded task args. The API does not run all Console JSON/schema validation before storing this value. The task runtime validates args.

Responses

Update executable gas mode

PATCH/api/v1/executables/{executableId}/gas-mode

Update gas configuration, subject to profile-specific restrictions. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
gasModeRequired
string

Available modes depend on the profile kind. Roles profiles require sponsored mode.

Values
sponsoredselfself-funded
gasFallback
boolean
sponsorshipProvider
string

Provider choice for eligible profiles. This field does not select managed Lift sponsorship.

Values
pimlicoalchemy

Responses

Pause executable

POST/api/v1/executables/{executableId}/pause

Pause scheduling. Check any already-running execution separately. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Responses

Set executable pinned

PATCH/api/v1/executables/{executableId}/pinned

Set whether the executable is pinned in the Console. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
pinnedRequired
boolean

Responses

Update executable profile

PATCH/api/v1/executables/{executableId}/profile

Select a compatible active profile in this project; function permission coverage is rechecked. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
profileIdRequired
string

Responses

Regenerate executable

POST/api/v1/executables/{executableId}/regenerate

Request regeneration of the executable sandbox; resource state restrictions apply. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Responses

Reprovision executable

POST/api/v1/executables/{executableId}/reprovision

Request replacement of the executable sandbox through the provisioning lifecycle. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Responses

Resume executable

POST/api/v1/executables/{executableId}/resume

Resume a ready executable; profile readiness and function permission coverage are rechecked. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Responses

Run executable

POST/api/v1/executables/{executableId}/run

Queue a real execution. A successful request is not on-chain confirmation. Permission checks run asynchronously and can fail after this response. Requires executables:run and owner/admin membership.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Responses

Update executable secrets

PATCH/api/v1/executables/{executableId}/secrets

Replace all secret bindings. An empty array clears bindings; secret values are never returned. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
secretBindings
object[]

Responses

Simulate executable

POST/api/v1/executables/{executableId}/simulate

Queue a cloud dry run. This does not submit the resulting calls to the chain. Required scope: executables:run. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Responses

Update executable sponsorship provider

PATCH/api/v1/executables/{executableId}/sponsorship-provider

Set the sponsorship provider for eligible profiles. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
sponsorshipProviderRequired
string

Provider choice for eligible profiles. This field does not select managed Lift sponsorship.

Values
pimlicoalchemy

Responses

Get executable storage

GET/api/v1/executables/{executableId}/storage

Returns the complete JSON object when its serialized size is at most 16 MiB. Required scope: storage:read.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Responses

Replace executable storage

PATCH/api/v1/executables/{executableId}/storage

Replaces the complete JSON object. The serialized value is limited to 16 MiB on this HTTP route. Required scope: storage:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
expectedVersionRequired
integer·min 0
valueRequired
object

Responses

Update executable trigger

PATCH/api/v1/executables/{executableId}/trigger

Replace the schedule. Cron and interval validation and workspace plan limits apply. Required scope: executables:write. Owner/admin membership is required.

Path Parameters

executableIdRequired
string

Header Parameters

X-Workspace-Id
string

Required for an unbound key; a management credential is already workspace-bound.

Idempotency-Key
string·min 1·max 128

Opaque 1–128 character key retained for 24 hours. Use a different key for every target resource and intended mutation: some fingerprints use the route template without the resource ID.

Request Body

application/json
triggerRequired

Responses