Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

GET /api/eureka/notebooks/:notebookKey

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
notebookKeypathstring · required

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/eureka/notebooks/strategy-11111111-1111-4111-8111-111111111111' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data
{
  "notebook": {
    "schema": "weavers.notebook.v1",
    "version": 1,
    "notebookKey": "strategy-11111111-1111-4111-8111-111111111111",
    "title": "Example research",
    "cells": [],
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  },
  "source": "default",
  "savedAt": null
}
View response model
notebook required · object
View notebook model
schema required · "weavers.notebook.v1"
version required · 1
notebookKey required · string
title required · string
cells required · array of object
View cells model

Array items:

id required · string
kind required · "bootstrap" | "code"
language required · "python" | "weavers-bootstrap"
locked required · boolean
strategyRunEnabled optional · false | true
source required · string
status required · "idle" | "running" | "success" | "stale" | "error" | "blocked"
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

Additional fields: JSON values.

createdAt required · string
updatedAt required · string
universeSource optional · null | object
View universeSource 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.

Additional fields: JSON values.

source required · "default" | "persisted"
savedAt required · null | string
View savedAt 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.