PATCH /api/eureka/notebooks/executions/:jobId

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.
Only valid job transitions for the job owner and execution backend are accepted. A user session does not grant worker authority.
Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.

Request

Parameter	Location	Type and requirement
`jobId`	path	string · required
`Origin`	header	string · required An origin allowed by this deployment.
`X-CSRF-Token`	header	string · required Must match the CSRF cookie issued to this browser.

Body · application/json

backendJobId optional · null | string

View backendJobId model

Variant 1: null

null

Variant 2: string

string

message optional · null | string

View message model

Variant 1: null

null

Variant 2: string

string

outputs optional · array of object

View outputs model

Array items:

id required · string

kind required · "error" | "text" | "json" | "table" | "chart"

text required · string

createdAt required · string

metadata optional · object

View metadata model

Additional fields: JSON value.

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

Save as request.json

{
  "status": "running"
}

cURL (POSIX shell)

curl --include \
  --request PATCH \
  'https://api.weavers.app/api/eureka/notebooks/executions/1' \
  --cookie cookies.txt --cookie-jar cookies.txt \
  --header 'Origin: https://weavers.app' \
  --header "X-CSRF-Token: ${CSRF_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "execution": {
    "schema": "weavers.notebook.execution.v2",
    "version": 2,
    "jobId": "1",
    "notebookKey": "strategy-11111111-1111-4111-8111-111111111111",
    "notebookRevision": "example",
    "cellId": "1",
    "cellIds": [],
    "mode": "all",
    "strategyRevision": 1,
    "dataContextSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "resourceLimits": {
      "timeoutSeconds": 1,
      "outputMaxBytes": 1
    },
    "backend": "local",
    "status": "running",
    "sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "sourceBytes": 1,
    "backendJobId": null,
    "message": "Explain the data used in this research.",
    "outputs": [],
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z",
    "completedAt": null
  }
}

View response model

execution required · object

View execution model

schema required · "weavers.notebook.execution.v2"

version required · 2

jobId required · string

notebookKey required · string

notebookRevision required · string

cellId required · string

cellIds required · array of string

View cellIds model

Array items:

string

mode required · "all" | "through_cell"

strategyRevision required · number

dataContextSha256 required · string

resourceLimits required · object

View resourceLimits model

timeoutSeconds required · number

outputMaxBytes required · number

Additional fields: JSON values.

backend required · "local" | "local_docker" | "local_gpu" | "remote_kubernetes"

sourceSha256 required · string

sourceBytes required · number

backendJobId required · null | string

View backendJobId model

Variant 1: null

null

Variant 2: string

string

message required · string

outputs required · array of object

View outputs model

Array items:

id required · string

kind required · "error" | "text" | "json" | "table" | "chart"

text required · string

createdAt required · string

metadata optional · object

View metadata model

Additional fields: JSON value.

Additional fields: JSON values.

createdAt required · string

updatedAt required · string

completedAt required · null | string

View completedAt model

Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

default · Operation-specific error. Inspect error/code before deciding whether to retry.

application/json

default example · synthetic data

{
  "error": "example",
  "code": "example"
}

View response model

error required · string

code required · string

Additional fields: JSON values.