Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

GET /api/optimisation/runs/:runId

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.

Request

ParameterLocationType and requirement
runIdpathstring · required
includeLogsquerystring · optional

No request body.

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.

cURL (POSIX shell)
curl --include \
  --request GET \
  'https://api.weavers.app/api/optimisation/runs/1' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data
{
  "run": {
    "runId": "1",
    "experimentKey": "tp_sl_two_stage",
    "templateKey": "tp_sl_two_stage_nsga2_v1",
    "status": "running",
    "visibility": "private",
    "publishedAt": null,
    "cluster": "dev",
    "workerCount": 1,
    "workersRunning": 1,
    "workersSucceeded": 1,
    "workersFailed": 1,
    "workersPending": 1,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "startedAt": null,
    "finishedAt": null,
    "cancelledAt": null,
    "requestedByEmail": null,
    "publishedStrategyId": null,
    "latestPublishJob": null,
    "publishPipeline": null,
    "parameters": {
      "dataProvider": "alpaca",
      "publishBenchmarkSymbol": "SPY",
      "objectivePreset": "balanced",
      "workerCount": 1,
      "startDate": null,
      "endDate": null,
      "equitiesOnly": false,
      "excludeEtfs": false,
      "excludeIndiaEtfs": false,
      "stageATrials": 1,
      "stageA2Mode": "disabled",
      "stageA2Trials": 1,
      "stageAToA2Threshold": 1,
      "stageA2HorizonBars": 1,
      "stageA2LabelMinUpPct": 1,
      "stageA2PredictorFeaturesCsv": "example",
      "stageBTrials": 1,
      "stageBExecutionTimeframe": "1d",
      "stageBMaxHoldingBars": 1,
      "lookbackYears": 1,
      "trainMonths": 1,
      "valMonths": 1,
      "stepMonths": 1,
      "purgeDays": 1,
      "holdoutMonths": 1,
      "horizonBars": 1,
      "labelMinUpPct": 1,
      "stageAFeatureTimeframe": "1d",
      "predictorFeaturesCsv": "example",
      "stageADecisionThreshold": 1,
      "stageALearningRateMin": 1,
      "stageALearningRateMax": 1,
      "stageAL2Min": 1,
      "stageAL2Max": 1,
      "stageAEpochsMin": 1,
      "stageAEpochsMax": 1,
      "stageAPosWeightMin": 1,
      "stageAPosWeightMax": 1,
      "tpMin": 1,
      "tpMax": 1,
      "slMin": 1,
      "slMax": 1,
      "reserveCashPctMin": 1,
      "reserveCashPctMax": 1,
      "optimizeProbThreshold": false,
      "probThresholdMin": 1,
      "probThresholdMax": 1,
      "executionMode": "notional",
      "executionBrokerId": "1",
      "leverageMode": "cash",
      "requestedLeverage": 1,
      "marginInterestAnnualRatePct": null,
      "marginInterestDayCountBasis": null,
      "marginInterestRateSource": null,
      "marginInterestBenchmarkId": null,
      "marginInterestBenchmarkRatePct": null,
      "marginInterestBenchmarkRateSeries": null,
      "marginInterestSpreadPct": null,
      "initialMarginRequirementPct": null,
      "maintenanceMarginRequirementPct": null,
      "marketFeeProfile": null,
      "initialCapital": 1,
      "riskPerTradePct": 1,
      "maxPositionPctEquity": 1,
      "maxGrossExposurePctEquity": 1,
      "allowFractionalShares": false,
      "maxTradesPerDay": null,
      "commissionBps": 1,
      "slippageBps": 1,
      "halfSpreadBps": 1,
      "borrowBpsPerBar": 1,
      "minTrades": 1,
      "maxDrawdown": 1,
      "drawdownGateMetric": "max_drawdown_p75",
      "maxSymbolConcentration": 1,
      "minRiskAdjusted": 1,
      "maxTurnover": null,
      "maxCvar95": null,
      "lambdaReturn": 1,
      "lambdaStability": 1,
      "lambdaTail": 1,
      "lambdaDrawdown": 1,
      "lambdaConcentration": 1,
      "lambdaTurnover": 1,
      "negativeRiskAdjustedPenalty": 1,
      "saveValidationTrades": false,
      "stageASeedBase": 1,
      "stageBSeedBase": 1
    },
    "errorCode": null,
    "errorMessage": null,
    "failureDiagnostic": null,
    "summary": {},
    "trajectories": {
      "stageA": null,
      "stageA2": null,
      "stageB": null
    },
    "trajectory": null,
    "analytics": null,
    "canEditVisibility": false
  },
  "workers": []
}
View response model
run required · object
View run model
runId required · string
experimentName optional · null | string
View experimentName model
Variant 1: null

null

Variant 2: string

string

eurekaStrategyWorkspaceId optional · string
candidate optional · object
View candidate model
id required · string
title required · string
nicheId required · null | number
View nicheId model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

Additional fields: JSON values.

runNumber optional · null | number
View runNumber model
Variant 1: null

null

Variant 2: number

number

method optional · null | object
View method model
Variant 1: null

null

Variant 2: object
strategyLabel required · string
purpose required · string
task required · string
algorithm required · null | object
View algorithm model
Variant 1: null

null

Variant 2: object
id required · string
label required · string
family required · string

Additional fields: JSON values.

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

null

Variant 2: string

string

algorithmSource required · "unavailable" | "configured" | "recorded"

Additional fields: JSON values.

experimentKey required · "tp_sl_two_stage"
templateKey required · "tp_sl_two_stage_nsga2_v1"
status required · "running" | "failed" | "cancelled" | "queued" | "completed" | "cancelling" | "provisioning" | "collecting"
visibility required · "private" | "community"
publishedAt required · null | string
View publishedAt model
Variant 1: null

null

Variant 2: string

string

cluster required · "dev"
workerCount required · number
workersRunning required · number
workersSucceeded required · number
workersFailed required · number
workersPending required · number
createdAt required · string
startedAt required · null | string
View startedAt model
Variant 1: null

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

ingestedRows optional · null | number
View ingestedRows model
Variant 1: null

null

Variant 2: number

number

rowProgress optional · null | object
View rowProgress model
Variant 1: null

null

Variant 2: object
phase required · null | string
View phase model
Variant 1: null

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

rawRows required · null | number
View rawRows model
Variant 1: null

null

Variant 2: number

number

selectedRows required · null | number
View selectedRows model
Variant 1: null

null

Variant 2: number

number

stageBInputRows required · null | number
View stageBInputRows model
Variant 1: null

null

Variant 2: number

number

preHoldoutRows required · null | number
View preHoldoutRows model
Variant 1: null

null

Variant 2: number

number

holdoutRows required · null | number
View holdoutRows model
Variant 1: null

null

Variant 2: number

number

stageBSignalRows required · null | number
View stageBSignalRows model
Variant 1: null

null

Variant 2: number

number

stageBTrialRows required · null | number
View stageBTrialRows model
Variant 1: null

null

Variant 2: number

number

stageAFinalRows required · null | number
View stageAFinalRows model
Variant 1: null

null

Variant 2: number

number

stageA2ScoredRows required · null | number
View stageA2ScoredRows model
Variant 1: null

null

Variant 2: number

number

symbolCount required · null | number
View symbolCount model
Variant 1: null

null

Variant 2: number

number

dayCount required · null | number
View dayCount model
Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

submittedConfiguration optional · object
View submittedConfiguration model
compute optional · object
View compute model
tier required · "included" | "accelerated"
vcpus required · number
memoryGiB required · number
maxHours required · number
maxTwigs required · number

Additional fields: JSON values.

experimentName optional · string
candidateSourceRunId optional · string
candidateTitle optional · string
experimentKey required · "tp_sl_two_stage"
templateKey required · "tp_sl_two_stage_nsga2_v1"
cluster required · "dev"
parameters required · object
View parameters model
dataProvider required · "alpaca"
publishBenchmarkSymbol required · "SPY"
objectivePreset required · "balanced" | "return_focus" | "risk_focus"
workerCount required · number
startDate required · null | string
View startDate model
Variant 1: null

null

Variant 2: string

string

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

null

Variant 2: string

string

equitiesOnly required · boolean
excludeEtfs required · boolean
excludeIndiaEtfs required · boolean
stageATrials required · number
stageA2Mode required · "disabled" | "auto"
stageA2Trials required · number
stageAToA2Threshold required · number
stageA2HorizonBars required · number
stageA2LabelMinUpPct required · number
stageA2PredictorFeaturesCsv required · string
stageBTrials required · number
stageBExecutionTimeframe required · "1d" | "4h" | "1h"
stageBMaxHoldingBars required · number
lookbackYears required · number
trainMonths required · number
valMonths required · number
stepMonths required · number
purgeDays required · number
holdoutMonths required · number
holdoutStartDate optional · null | string
View holdoutStartDate model
Variant 1: null

null

Variant 2: string

string

horizonBars required · number
labelMinUpPct required · number
stageAFeatureTimeframe required · "1d"
predictorFeaturesCsv required · string
stageADecisionThreshold required · number
entryFilters optional · null | object
View entryFilters model
Variant 1: null

null

Variant 2: object
schema_version required · 1
bar required · "1d"
condition required · object
View condition model
Variant 1: object
op required · "cross_above" | "cross_below" | "gt" | "gte" | "lt" | "lte"
left required · number | object
View left model
Variant 1: number

number

Variant 2: object
field required · "close" | "volume"

Additional fields: JSON values.

Variant 3: object
indicator required · "sma" | "ema" | "rsi" | "atr"
period required · number

Additional fields: JSON values.

Variant 4: object
indicator required · "macd"
fast required · number
slow required · number
signal required · number
component required · "line" | "signal" | "histogram"

Additional fields: JSON values.

right required · number | object
View right model
Variant 1: number

number

Variant 2: object
field required · "close" | "volume"

Additional fields: JSON values.

Variant 3: object
indicator required · "sma" | "ema" | "rsi" | "atr"
period required · number

Additional fields: JSON values.

Variant 4: object
indicator required · "macd"
fast required · number
slow required · number
signal required · number
component required · "line" | "signal" | "histogram"

Additional fields: JSON values.

Additional fields: JSON values.

Variant 2: object
op required · "and" | "or"
conditions required · array of object
View conditions model

Array items:

op required · "cross_above" | "cross_below" | "gt" | "gte" | "lt" | "lte"
left required · number | object
View left model
Variant 1: number

number

Variant 2: object
field required · "close" | "volume"

Additional fields: JSON values.

Variant 3: object
indicator required · "sma" | "ema" | "rsi" | "atr"
period required · number

Additional fields: JSON values.

Variant 4: object
indicator required · "macd"
fast required · number
slow required · number
signal required · number
component required · "line" | "signal" | "histogram"

Additional fields: JSON values.

right required · number | object
View right model
Variant 1: number

number

Variant 2: object
field required · "close" | "volume"

Additional fields: JSON values.

Variant 3: object
indicator required · "sma" | "ema" | "rsi" | "atr"
period required · number

Additional fields: JSON values.

Variant 4: object
indicator required · "macd"
fast required · number
slow required · number
signal required · number
component required · "line" | "signal" | "histogram"

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

stageALearningRateMin required · number
stageALearningRateMax required · number
stageAL2Min required · number
stageAL2Max required · number
stageAEpochsMin required · number
stageAEpochsMax required · number
stageAPosWeightMin required · number
stageAPosWeightMax required · number
tpMin required · number
tpMax required · number
slMin required · number
slMax required · number
reserveCashPctMin required · number
reserveCashPctMax required · number
optimizeProbThreshold required · boolean
probThresholdMin required · number
probThresholdMax required · number
executionMode required · "notional" | "capital"
executionBrokerId required · string
leverageMode required · "cash" | "reg_t"
requestedLeverage required · 1 | 2
marginInterestAnnualRatePct required · null | number
View marginInterestAnnualRatePct model
Variant 1: null

null

Variant 2: number

number

marginInterestDayCountBasis required · null | number
View marginInterestDayCountBasis model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

marginInterestBenchmarkRatePct required · null | number
View marginInterestBenchmarkRatePct model
Variant 1: null

null

Variant 2: number

number

marginInterestBenchmarkRateSeries required · null | array of object
View marginInterestBenchmarkRateSeries model
Variant 1: null

null

Variant 2: array of object

Array items:

date required · string
rate_pct required · number

Additional fields: JSON values.

marginInterestSpreadPct required · null | number
View marginInterestSpreadPct model
Variant 1: null

null

Variant 2: number

number

initialMarginRequirementPct required · null | number
View initialMarginRequirementPct model
Variant 1: null

null

Variant 2: number

number

maintenanceMarginRequirementPct required · null | number
View maintenanceMarginRequirementPct model
Variant 1: null

null

Variant 2: number

number

marketFeeProfile required · null | object
View marketFeeProfile model
Variant 1: null

null

Variant 2: object

Additional fields: JSON value.

initialCapital required · number
riskPerTradePct required · number
maxPositionPctEquity required · number
maxGrossExposurePctEquity required · number
allowFractionalShares required · boolean
maxTradesPerDay required · null | number
View maxTradesPerDay model
Variant 1: null

null

Variant 2: number

number

commissionBps required · number
slippageBps required · number
halfSpreadBps required · number
borrowBpsPerBar required · number
minTrades required · number
maxDrawdown required · number
drawdownGateMetric required · "max_drawdown_p75" | "max_drawdown_stitched"
maxSymbolConcentration required · number
minRiskAdjusted required · number
maxTurnover required · null | number
View maxTurnover model
Variant 1: null

null

Variant 2: number

number

maxCvar95 required · null | number
View maxCvar95 model
Variant 1: null

null

Variant 2: number

number

lambdaReturn required · number
lambdaStability required · number
lambdaTail required · number
lambdaDrawdown required · number
lambdaConcentration required · number
lambdaTurnover required · number
negativeRiskAdjustedPenalty required · number
saveValidationTrades required · boolean
stageASeedBase required · number
stageBSeedBase required · number

Additional fields: JSON values.

executionPlan required · object
View executionPlan model
mode required · "stage_a_only" | "stage_b_only" | "stage_a_to_b"
stageASourceRunId required · null | string
View stageASourceRunId model
Variant 1: null

null

Variant 2: string

string

stageAStudyName optional · null | string
View stageAStudyName model
Variant 1: null

null

Variant 2: string

string

stageAComponent optional · null | object
View stageAComponent model
Variant 1: null

null

Variant 2: object
sourceKind required · "weavers_preset"
componentType required · "stage_a" | "stage_b"
componentKey required · string

Additional fields: JSON values.

Variant 3: object
sourceKind required · "notebook_component"
componentType required · "stage_a" | "stage_b"
componentKey required · string

Additional fields: JSON values.

stageBComponent optional · null | object
View stageBComponent model
Variant 1: null

null

Variant 2: object
sourceKind required · "weavers_preset"
componentType required · "stage_a" | "stage_b"
componentKey required · string

Additional fields: JSON values.

Variant 3: object
sourceKind required · "notebook_component"
componentType required · "stage_a" | "stage_b"
componentKey required · string

Additional fields: JSON values.

canvas required · null | object
View canvas model
Variant 1: null

null

Variant 2: object
version required · 1
nodes required · array of object
View nodes model

Array items:

id required · string
kind required · "stage_a_trainer" | "stage_b_entry_gate" | "stage_b_feasibility_gate" | "stage_b_optimizer"
x required · number
y required · number

Additional fields: JSON values.

edges required · array of object
View edges model

Array items:

id required · string
source required · string
target required · string

Additional fields: JSON values.

Additional fields: JSON values.

stageAUniverseSource optional · null | object
View stageAUniverseSource model
Variant 1: null

null

Variant 2: object
type required · "base"

Additional fields: JSON values.

Variant 3: object
type required · "platform_niche"
nicheId required · number
nicheKey required · string

Additional fields: JSON values.

Variant 4: object
type required · "ticker_pool"
symbols required · array of string
View symbols model

Array items:

string

Additional fields: JSON values.

stageADataSelectors optional · null | object
View stageADataSelectors model
Variant 1: null

null

Variant 2: object
matchMode required · "all" | "any"
selectors required · array of object
View selectors model

Array items:

Variant 1: object
type required · "channel"
timeframe required · "1d" | "4h" | "1h"
windowDays required · number
directions required · array of "ascending" | "descending"
View directions model

Array items:

"ascending" | "descending"

requireValid required · boolean
algoVersion optional · string
characteristics optional · object
View characteristics model
states optional · array of "new" | "continuing"
View states model

Array items:

"new" | "continuing"

minR2 optional · number
maxR2 optional · number
minBandPosition optional · number
maxBandPosition optional · number
minBandWidthRatio optional · number
maxBandWidthRatio optional · number
minNormalizedSlope optional · number
maxNormalizedSlope optional · number
minConsecutiveRuns optional · number
maxConsecutiveRuns optional · number

Additional fields: JSON values.

missingDataPolicy required · "skip_and_log"

Additional fields: JSON values.

Variant 2: object
type required · "regime"
source required · "snapshot"
regime required · "bull" | "bear" | "stable"
minConfidence required · number
missingDataPolicy required · "skip_and_log"

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

seedConfig optional · null | object
View seedConfig model
Variant 1: null

null

Variant 2: object
sourceStrategyId required · string
sourceStrategyRegistryId required · number
sourceArtifactId required · number
sourceRunId required · null | string
View sourceRunId model
Variant 1: null

null

Variant 2: string

string

stageAConfig required · object
View stageAConfig model

Additional fields: JSON value.

finalExecutionConfig required · object
View finalExecutionConfig model

Additional fields: JSON value.

Additional fields: JSON values.

clientLaunch optional · null | object
View clientLaunch model
Variant 1: null

null

Variant 2: object
validationRevisionId optional · string
eurekaStrategyWorkspaceId optional · string
researchQuestion optional · string
submittedAt required · string
timezone required · null | string
View timezone model
Variant 1: null

null

Variant 2: string

string

localTimestamp required · string
notebookStrategyRun optional · null | object
View notebookStrategyRun model
Variant 1: null

null

Variant 2: object
schema required · "weavers.notebook.strategy_run.v1"
notebookKey required · string
notebookSavedAt required · string
selectedCells required · array of object
View selectedCells model

Array items:

cellId required · string
sourceSha256 required · string
sourceBytes required · number
sourceUpdatedAt required · string

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

researchQuestion optional · null | string
View researchQuestion model
Variant 1: null

null

Variant 2: string

string

computeUsage optional · object
View computeUsage model
budget required · object
View budget model
tier required · "included" | "accelerated"
vcpus required · number
memoryGiB required · number
maxHours required · number
maxTwigs required · number

Additional fields: JSON values.

reservedTwigs required · number
chargedTwigs required · null | number
View chargedTwigs model
Variant 1: null

null

Variant 2: number

number

allocatedVcpuHours required · number

Additional fields: JSON values.

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

null

Variant 2: string

string

latestPublishJob required · null | object
View latestPublishJob model
Variant 1: null

null

Variant 2: object
jobId required · string
runId required · string
status required · "running" | "succeeded" | "failed" | "queued" | "awaiting_stress_test"
stressTestId required · null | number
View stressTestId model
Variant 1: null

null

Variant 2: number

number

stressTestStatus required · null | "running" | "error" | "failed" | "queued" | "waiting_resources" | "passed"
View stressTestStatus model
Variant 1: null

null

Variant 2: "running"

"running"

Variant 3: "error"

"error"

Variant 4: "failed"

"failed"

Variant 5: "queued"

"queued"

Variant 6: "waiting_resources"

"waiting_resources"

Variant 7: "passed"

"passed"

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

request required · object
View request model
displayName required · string
strategyKey required · null | string
View strategyKey model
Variant 1: null

null

Variant 2: string

string

activateNow required · boolean
monteCarloExecutionMode required · "default" | "skip"

Additional fields: JSON values.

result required · null | object
View result model
Variant 1: null

null

Variant 2: object
strategyRegistryId required · number
strategyKey required · string
strategyVariant required · string
strategyId required · string
alias required · string
displayName required · null | string
View displayName model
Variant 1: null

null

Variant 2: string

string

artifactId required · number
publishedAt required · string

Additional fields: JSON values.

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

Additional fields: JSON values.

publishPipeline required · null | object
View publishPipeline model
Variant 1: null

null

Variant 2: object
fit required · object
View fit model
status required · "running" | "completed" | "not_started"
artifactId required · null | number
View artifactId model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

finalExecutionStage required · null | "stage_b"
View finalExecutionStage model
Variant 1: null

null

Variant 2: "stage_b"

"stage_b"

selectedStageATrialId required · null | number
View selectedStageATrialId model
Variant 1: null

null

Variant 2: number

number

selectedStageBTrialId required · null | number
View selectedStageBTrialId model
Variant 1: null

null

Variant 2: number

number

selectedFinalExecutionTrialId required · null | number
View selectedFinalExecutionTrialId model
Variant 1: null

null

Variant 2: number

number

selectedStageBInputTrialId required · null | number
View selectedStageBInputTrialId model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

Additional fields: JSON values.

registry required · object
View registry model
strategyRegistryId required · null | number
View strategyRegistryId model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

nicheId required · null | number
View nicheId model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

Additional fields: JSON values.

stress required · object
View stress model
stressTestId required · null | number
View stressTestId model
Variant 1: null

null

Variant 2: number

number

status required · "running" | "error" | "failed" | "queued" | "not_started" | "waiting_resources" | "passed"
progressStage required · null | string
View progressStage model
Variant 1: null

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

passedGateCount required · number
failedGateCount required · number
failedGateNames required · array of string
View failedGateNames model

Array items:

string

warningGateCount required · number
warningGateNames required · array of string
View warningGateNames model

Array items:

string

gates optional · array of object
View gates model

Array items:

key required · string
label required · string
state required · "failed" | "unavailable" | "passed" | "warning"
blocking required · boolean
actual required · null | string
View actual model
Variant 1: null

null

Variant 2: string

string

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

null

Variant 2: string

string

detail required · string

Additional fields: JSON values.

promotionSharpe required · null | number
View promotionSharpe model
Variant 1: null

null

Variant 2: number

number

syntheticRegimeEquityChart required · null | object
View syntheticRegimeEquityChart model
Variant 1: null

null

Variant 2: object
kind optional · "line"
templateKey required · string
title required · string
description required · string
yAxisLabel required · string
valueFormat required · "number" | "currency" | "percent"
series required · array of object
View series model

Array items:

key required · string
label required · string
points required · array of object
View points model

Array items:

day required · string
value required · number

Additional fields: JSON values.

Additional fields: JSON values.

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

null

Variant 2: string

string

Additional fields: JSON values.

Additional fields: JSON values.

paper required · object
View paper model
status required · "blocked" | "failed" | "queued" | "active" | "promoted" | "withdrawn" | "not_started"
artifactLifecycleStatus required · null | string
View artifactLifecycleStatus model
Variant 1: null

null

Variant 2: string

string

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

null

Variant 2: string

string

executionSource optional · null | "broker_backed" | "internal_simulation"
View executionSource model
Variant 1: null

null

Variant 2: "broker_backed"

"broker_backed"

Variant 3: "internal_simulation"

"internal_simulation"

brokerReadinessStatus optional · null | "blocked" | "ready" | "queued"
View brokerReadinessStatus model
Variant 1: null

null

Variant 2: "blocked"

"blocked"

Variant 3: "ready"

"ready"

Variant 4: "queued"

"queued"

brokerProviderId optional · null | string
View brokerProviderId model
Variant 1: null

null

Variant 2: string

string

brokerConnectMode optional · null | "api_key" | "oauth"
View brokerConnectMode model
Variant 1: null

null

Variant 2: "api_key"

"api_key"

Variant 3: "oauth"

"oauth"

brokerAccountId optional · null | string
View brokerAccountId model
Variant 1: null

null

Variant 2: string

string

brokerBlockedReasonCode optional · null | string
View brokerBlockedReasonCode model
Variant 1: null

null

Variant 2: string

string

brokerBlockedReasonDetail optional · null | string
View brokerBlockedReasonDetail model
Variant 1: null

null

Variant 2: string

string

brokerReadyAt optional · null | string
View brokerReadyAt model
Variant 1: null

null

Variant 2: string

string

protection optional · null | object
View protection model
Variant 1: null

null

Variant 2: object
brokerBracketOpenPositions required · number
weaversManagedOpenPositions required · number
protectionDegradedOpenPositions required · number

Additional fields: JSON values.

liveOrFailStatus required · "failed" | "live" | "pending"
paperPeriodId required · null | number
View paperPeriodId model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

requiredDays required · null | number
View requiredDays model
Variant 1: null

null

Variant 2: number

number

tradingDaysElapsed required · null | number
View tradingDaysElapsed model
Variant 1: null

null

Variant 2: number

number

outcome required · null | "failed" | "promoted" | "withdrawn"
View outcome model
Variant 1: null

null

Variant 2: "failed"

"failed"

Variant 3: "promoted"

"promoted"

Variant 4: "withdrawn"

"withdrawn"

paperSharpe required · null | number
View paperSharpe model
Variant 1: null

null

Variant 2: number

number

stressSharpe required · null | number
View stressSharpe model
Variant 1: null

null

Variant 2: number

number

requiredPaperSharpe required · null | number
View requiredPaperSharpe model
Variant 1: null

null

Variant 2: number

number

gatePassed required · null | false | true
View gatePassed model
Variant 1: null

null

Variant 2: false

false

Variant 3: true

true

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

null

Variant 2: string

string

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

null

Variant 2: string

string

evaluatedTradingDays required · null | number
View evaluatedTradingDays model
Variant 1: null

null

Variant 2: number

number

tradeCount required · null | number
View tradeCount model
Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

Additional fields: JSON values.

parameters required · object
View parameters model
dataProvider required · "alpaca"
publishBenchmarkSymbol required · "SPY"
objectivePreset required · "balanced" | "return_focus" | "risk_focus"
workerCount required · number
startDate required · null | string
View startDate model
Variant 1: null

null

Variant 2: string

string

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

null

Variant 2: string

string

equitiesOnly required · boolean
excludeEtfs required · boolean
excludeIndiaEtfs required · boolean
stageATrials required · number
stageA2Mode required · "disabled" | "auto"
stageA2Trials required · number
stageAToA2Threshold required · number
stageA2HorizonBars required · number
stageA2LabelMinUpPct required · number
stageA2PredictorFeaturesCsv required · string
stageBTrials required · number
stageBExecutionTimeframe required · "1d" | "4h" | "1h"
stageBMaxHoldingBars required · number
lookbackYears required · number
trainMonths required · number
valMonths required · number
stepMonths required · number
purgeDays required · number
holdoutMonths required · number
holdoutStartDate optional · null | string
View holdoutStartDate model
Variant 1: null

null

Variant 2: string

string

horizonBars required · number
labelMinUpPct required · number
stageAFeatureTimeframe required · "1d"
predictorFeaturesCsv required · string
stageADecisionThreshold required · number
entryFilters optional · null | object
View entryFilters model
Variant 1: null

null

Variant 2: object
schema_version required · 1
bar required · "1d"
condition required · object
View condition model
Variant 1: object
op required · "cross_above" | "cross_below" | "gt" | "gte" | "lt" | "lte"
left required · number | object
View left model
Variant 1: number

number

Variant 2: object
field required · "close" | "volume"

Additional fields: JSON values.

Variant 3: object
indicator required · "sma" | "ema" | "rsi" | "atr"
period required · number

Additional fields: JSON values.

Variant 4: object
indicator required · "macd"
fast required · number
slow required · number
signal required · number
component required · "line" | "signal" | "histogram"

Additional fields: JSON values.

right required · number | object
View right model
Variant 1: number

number

Variant 2: object
field required · "close" | "volume"

Additional fields: JSON values.

Variant 3: object
indicator required · "sma" | "ema" | "rsi" | "atr"
period required · number

Additional fields: JSON values.

Variant 4: object
indicator required · "macd"
fast required · number
slow required · number
signal required · number
component required · "line" | "signal" | "histogram"

Additional fields: JSON values.

Additional fields: JSON values.

Variant 2: object
op required · "and" | "or"
conditions required · array of object
View conditions model

Array items:

op required · "cross_above" | "cross_below" | "gt" | "gte" | "lt" | "lte"
left required · number | object
View left model
Variant 1: number

number

Variant 2: object
field required · "close" | "volume"

Additional fields: JSON values.

Variant 3: object
indicator required · "sma" | "ema" | "rsi" | "atr"
period required · number

Additional fields: JSON values.

Variant 4: object
indicator required · "macd"
fast required · number
slow required · number
signal required · number
component required · "line" | "signal" | "histogram"

Additional fields: JSON values.

right required · number | object
View right model
Variant 1: number

number

Variant 2: object
field required · "close" | "volume"

Additional fields: JSON values.

Variant 3: object
indicator required · "sma" | "ema" | "rsi" | "atr"
period required · number

Additional fields: JSON values.

Variant 4: object
indicator required · "macd"
fast required · number
slow required · number
signal required · number
component required · "line" | "signal" | "histogram"

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

stageALearningRateMin required · number
stageALearningRateMax required · number
stageAL2Min required · number
stageAL2Max required · number
stageAEpochsMin required · number
stageAEpochsMax required · number
stageAPosWeightMin required · number
stageAPosWeightMax required · number
tpMin required · number
tpMax required · number
slMin required · number
slMax required · number
reserveCashPctMin required · number
reserveCashPctMax required · number
optimizeProbThreshold required · boolean
probThresholdMin required · number
probThresholdMax required · number
executionMode required · "notional" | "capital"
executionBrokerId required · string
leverageMode required · "cash" | "reg_t"
requestedLeverage required · 1 | 2
marginInterestAnnualRatePct required · null | number
View marginInterestAnnualRatePct model
Variant 1: null

null

Variant 2: number

number

marginInterestDayCountBasis required · null | number
View marginInterestDayCountBasis model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

marginInterestBenchmarkRatePct required · null | number
View marginInterestBenchmarkRatePct model
Variant 1: null

null

Variant 2: number

number

marginInterestBenchmarkRateSeries required · null | array of object
View marginInterestBenchmarkRateSeries model
Variant 1: null

null

Variant 2: array of object

Array items:

date required · string
rate_pct required · number

Additional fields: JSON values.

marginInterestSpreadPct required · null | number
View marginInterestSpreadPct model
Variant 1: null

null

Variant 2: number

number

initialMarginRequirementPct required · null | number
View initialMarginRequirementPct model
Variant 1: null

null

Variant 2: number

number

maintenanceMarginRequirementPct required · null | number
View maintenanceMarginRequirementPct model
Variant 1: null

null

Variant 2: number

number

marketFeeProfile required · null | object
View marketFeeProfile model
Variant 1: null

null

Variant 2: object

Additional fields: JSON value.

initialCapital required · number
riskPerTradePct required · number
maxPositionPctEquity required · number
maxGrossExposurePctEquity required · number
allowFractionalShares required · boolean
maxTradesPerDay required · null | number
View maxTradesPerDay model
Variant 1: null

null

Variant 2: number

number

commissionBps required · number
slippageBps required · number
halfSpreadBps required · number
borrowBpsPerBar required · number
minTrades required · number
maxDrawdown required · number
drawdownGateMetric required · "max_drawdown_p75" | "max_drawdown_stitched"
maxSymbolConcentration required · number
minRiskAdjusted required · number
maxTurnover required · null | number
View maxTurnover model
Variant 1: null

null

Variant 2: number

number

maxCvar95 required · null | number
View maxCvar95 model
Variant 1: null

null

Variant 2: number

number

lambdaReturn required · number
lambdaStability required · number
lambdaTail required · number
lambdaDrawdown required · number
lambdaConcentration required · number
lambdaTurnover required · number
negativeRiskAdjustedPenalty required · number
saveValidationTrades required · boolean
stageASeedBase required · number
stageBSeedBase required · number

Additional fields: JSON values.

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

null

Variant 2: string

string

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

null

Variant 2: string

string

failureDiagnostic required · null | object
View failureDiagnostic model
Variant 1: null

null

Variant 2: object
version required · 1
code required · string
stage required · "configuration" | "dataset" | "signal_predictor" | "signal_refinement" | "execution_policy" | "infrastructure" | "unknown"
category required · "model" | "configuration" | "infrastructure" | "unknown" | "data_quality" | "feasibility"
reason required · string
retryable required · boolean
evidence required · object
View evidence model

Additional fields: null | string | number | false | true.

adjustments required · array of object
View adjustments model

Array items:

parameterKey required · string
direction required · "increase" | "decrease" | "review"
priority required · "primary" | "alternative"
basis optional · object
View basis model
kind required · "label_threshold_search"
currentValue required · number
suggestedValue required · null | number
View suggestedValue model
Variant 1: null

null

Variant 2: number

number

step required · number
maxValue required · number
minPositives required · number
minNegatives required · number
minPositiveRate required · number
maxPositiveRate required · number
windowsTotal required · number
windowsFailingBefore required · number
windowsFailingAfter required · null | number
View windowsFailingAfter model
Variant 1: null

null

Variant 2: number

number

windows required · array of object
View windows model

Array items:

start required · string
end required · string
support required · number
upBefore required · number
upAfter required · null | number
View upAfter model
Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

summary required · object
View summary model

Additional fields: JSON value.

trajectories required · object
View trajectories model
stageA required · null | object
View stageA model
Variant 1: null

null

Variant 2: object
studyName required · string
generatedAt required · string
points required · array of object
View points model

Array items:

trialId required · number
prAuc required · null | number
View prAuc model
Variant 1: null

null

Variant 2: number

number

logloss required · null | number
View logloss model
Variant 1: null

null

Variant 2: number

number

f1 required · null | number
View f1 model
Variant 1: null

null

Variant 2: number

number

bestSoFarPrAuc required · null | number
View bestSoFarPrAuc model
Variant 1: null

null

Variant 2: number

number

bestSoFarLogloss required · null | number
View bestSoFarLogloss model
Variant 1: null

null

Variant 2: number

number

bestSoFarF1 required · null | number
View bestSoFarF1 model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

backendFallback required · null | false | true
View backendFallback model
Variant 1: null

null

Variant 2: false

false

Variant 3: true

true

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

null

Variant 2: string

string

Additional fields: JSON values.

series required · object
View series model
bestSoFarPrAuc required · array of object
View bestSoFarPrAuc model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

bestSoFarLogloss required · array of object
View bestSoFarLogloss model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

bestSoFarF1 required · array of object
View bestSoFarF1 model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

Additional fields: JSON values.

counts required · object
View counts model
totalPoints required · number
loglossPoints required · number
f1Points required · number

Additional fields: JSON values.

Additional fields: JSON values.

stageA2 required · null | object
View stageA2 model
Variant 1: null

null

Variant 2: object
studyName required · string
generatedAt required · string
points required · array of object
View points model

Array items:

trialId required · number
prAuc required · null | number
View prAuc model
Variant 1: null

null

Variant 2: number

number

logloss required · null | number
View logloss model
Variant 1: null

null

Variant 2: number

number

f1 required · null | number
View f1 model
Variant 1: null

null

Variant 2: number

number

bestSoFarPrAuc required · null | number
View bestSoFarPrAuc model
Variant 1: null

null

Variant 2: number

number

bestSoFarLogloss required · null | number
View bestSoFarLogloss model
Variant 1: null

null

Variant 2: number

number

bestSoFarF1 required · null | number
View bestSoFarF1 model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

backendFallback required · null | false | true
View backendFallback model
Variant 1: null

null

Variant 2: false

false

Variant 3: true

true

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

null

Variant 2: string

string

Additional fields: JSON values.

series required · object
View series model
bestSoFarPrAuc required · array of object
View bestSoFarPrAuc model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

bestSoFarLogloss required · array of object
View bestSoFarLogloss model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

bestSoFarF1 required · array of object
View bestSoFarF1 model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

Additional fields: JSON values.

counts required · object
View counts model
totalPoints required · number
loglossPoints required · number
f1Points required · number

Additional fields: JSON values.

Additional fields: JSON values.

stageB required · null | object
View stageB model
Variant 1: null

null

Variant 2: object
studyName required · string
generatedAt required · string
points required · array of object
View points model

Array items:

constraintViolations optional · object
View constraintViolations model

Additional fields: null | number.

constraintMetrics optional · object
View constraintMetrics model

Additional fields: null | number.

trialId required · number
objective1 required · number
objective2 required · number
feasible required · boolean
bestSoFarObjective1 required · number
bestSoFarObjective2 required · number
feasibleCountSoFar required · number
feasibleRatio required · number
timestampUtc required · null | string
View timestampUtc model
Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

series required · object
View series model
bestSoFarObjective1 required · array of object
View bestSoFarObjective1 model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

bestSoFarObjective2 required · array of object
View bestSoFarObjective2 model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

feasibleRatio required · array of object
View feasibleRatio model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

Additional fields: JSON values.

counts required · object
View counts model
totalPoints required · number
feasiblePoints required · number
infeasiblePoints required · number

Additional fields: JSON values.

Additional fields: JSON values.

Additional fields: JSON values.

trajectory required · null | object
View trajectory model
Variant 1: null

null

Variant 2: object
studyName required · string
generatedAt required · string
points required · array of object
View points model

Array items:

constraintViolations optional · object
View constraintViolations model

Additional fields: null | number.

constraintMetrics optional · object
View constraintMetrics model

Additional fields: null | number.

trialId required · number
objective1 required · number
objective2 required · number
feasible required · boolean
bestSoFarObjective1 required · number
bestSoFarObjective2 required · number
feasibleCountSoFar required · number
feasibleRatio required · number
timestampUtc required · null | string
View timestampUtc model
Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

series required · object
View series model
bestSoFarObjective1 required · array of object
View bestSoFarObjective1 model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

bestSoFarObjective2 required · array of object
View bestSoFarObjective2 model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

feasibleRatio required · array of object
View feasibleRatio model

Array items:

trialId required · number
value required · number

Additional fields: JSON values.

Additional fields: JSON values.

counts required · object
View counts model
totalPoints required · number
feasiblePoints required · number
infeasiblePoints required · number

Additional fields: JSON values.

Additional fields: JSON values.

analytics required · null | object
View analytics model
Variant 1: null

null

Variant 2: object
sourceWorkerKey required · string
winnerTrialId required · number
winnerObjective1 required · number
winnerObjective2 required · number
winnerFeasible required · boolean
winner required · object
View winner model

Additional fields: JSON value.

holdout required · object
View holdout model

Additional fields: JSON value.

paretoFrontier required · array of object
View paretoFrontier model

Array items:

trialId required · number
objective1 required · number
objective2 required · number
feasible required · boolean
isWinner required · boolean

Additional fields: JSON values.

holdoutEquityCurve required · array of object
View holdoutEquityCurve model

Array items:

day required · string
equity required · number
drawdown required · number

Additional fields: JSON values.

stageACalibration required · null | object
View stageACalibration model
Variant 1: null

null

Variant 2: object
brier required · null | number
View brier model
Variant 1: null

null

Variant 2: number

number

ece required · null | number
View ece model
Variant 1: null

null

Variant 2: number

number

bins required · array of object
View bins model

Array items:

pMean required · number
yRate required · number
count required · number

Additional fields: JSON values.

Additional fields: JSON values.

equityOverlay required · null | object
View equityOverlay model
Variant 1: null

null

Variant 2: object
validation required · array of object
View validation model

Array items:

day required · string
equity required · number
drawdown required · number

Additional fields: JSON values.

holdout required · array of object
View holdout model

Array items:

day required · string
equity required · number
drawdown required · number

Additional fields: JSON values.

Additional fields: JSON values.

holdoutTradeCount required · number
validationTradeCount optional · number
holdoutLeverage optional · object
View holdoutLeverage model
tradeCount required · number
observedTradeCount required · number
minMultiplier required · null | number
View minMultiplier model
Variant 1: null

null

Variant 2: number

number

maxMultiplier required · null | number
View maxMultiplier model
Variant 1: null

null

Variant 2: number

number

borrowedTradeCount required · number
borrowingObservedTradeCount required · number
maxBorrowedNotional required · null | number
View maxBorrowedNotional model
Variant 1: null

null

Variant 2: number

number

marginInterestTotal required · null | number
View marginInterestTotal model
Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

updatedAt required · string

Additional fields: JSON values.

canEditVisibility required · boolean

Additional fields: JSON values.

workers required · array of object
View workers model

Array items:

workerKey required · string
attempt required · number
status required · "running" | "succeeded" | "failed" | "cancelled" | "pending" | "provisioning"
k8sJobName required · null | string
View k8sJobName model
Variant 1: null

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

exitCode required · null | number
View exitCode model
Variant 1: null

null

Variant 2: number

number

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

null

Variant 2: string

string

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

null

Variant 2: string

string

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

null

Variant 2: string

string

updatedAt required · string

Additional fields: JSON values.

Additional fields: JSON values.

400 · Invalid request.

application/json

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

404 · Resource or enabled capability not found.

application/json

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