Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

POST /api/me/strategies/:strategyId/runtime-control

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.
  • pause requires a positive pauseMinutes value. activate and kill do not require pauseMinutes. The account must control the selected strategy runtime.
  • Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.

Request

ParameterLocationType and requirement
strategyIdpathstring · required
Originheaderstring · required

An origin allowed by this deployment.

X-CSRF-Tokenheaderstring · required

Must match the CSRF cookie issued to this browser.

Body · application/json

action required · "activate" | "pause" | "kill"
pauseMinutes optional · number | string

A positive whole number of minutes. Required when action is pause.. A positive whole number of minutes. Required when action is pause.

reason optional · string | null

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
{
  "action": "pause",
  "pauseMinutes": 30
}
cURL (POSIX shell)
curl --include \
  --request POST \
  'https://api.weavers.app/api/me/strategies/11111111-1111-4111-8111-111111111111/runtime-control' \
  --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
{
  "strategyId": "11111111-1111-4111-8111-111111111111",
  "autoExecution": {
    "scope": "paper",
    "state": "active",
    "pauseUntil": null,
    "reason": null,
    "updatedAt": null
  }
}
View response model
strategyId required · string
autoExecution required · object
View autoExecution model
scope required · "paper"
state required · "active" | "paused" | "killed"
pauseUntil required · null | string
View pauseUntil model
Variant 1: null

null

Variant 2: string

string

reason required · null | string
View reason model
Variant 1: null

null

Variant 2: string

string

updatedAt required · null | string
View updatedAt model
Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data
{
  "error": "invalid_strategy_id"
}
View response model
Variant 1: object
error required · "invalid_strategy_id" | "strategy_id_required"

Additional fields: JSON values.

Variant 2: object
error required · "invalid_control_action" | "invalid_pause_minutes"

Additional fields: JSON values.

Variant 3: object
error required · 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
{
  "error": "example"
}
View response model
error required · string

Additional fields: JSON values.

404 · Resource or enabled capability not found.

application/json

404 example · synthetic data
{
  "error": "example"
}
View response model
error required · 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
{
  "error": "example"
}
View response model
error required · string

Additional fields: JSON values.