Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

Endpoint directory

Browse Weavers API operations for accounts, strategies, research, notebooks, brokers and support. Filter by resource, HTTP method and access requirements.

Browse every customer-facing HTTP operation. Each reference page includes request fields, nested models, response examples and errors. Download the complete OpenAPI specification for tooling.

Start with the authentication and request guide before using account actions. Colon-prefixed path segments, such as :strategyId, must be replaced with an identifier you can access.

211 of 211 operations

Account and sign-in 28

Create an account, complete verification, manage your profile and inspect your session.

  • Sign-in sets an HttpOnly session cookie. The account must satisfy the sign-in and verification checks.
  • Social sign-in uses a browser redirect and a state-bound callback. Start the flow before calling its completion endpoints.
  • Profile updates affect the signed-in account. Avatar uploads use an image data URL; public avatar reads return image content.
POST/api/auth/signupAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/auth/verifyAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/auth/signinAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/auth/googleAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/auth/logoutAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/auth/csrfAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/auth/checkAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/auth/forgot-passwordAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/auth/reset-passwordAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/auth/resend-verificationAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/avatars/:keyPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/meAccount required
PATCH/api/meAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/me/timezoneAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/me/heartbeatAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/me/backtestsAccount required
GET/api/me/interactionsAccount required
GET/api/me/coinsAccount required
POST/api/me/onboarding/completeAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/profileAccount required
PATCH/api/profileAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/auth/social/providersAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/auth/social/:provider/startAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/auth/social/:provider/callbackAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/auth/social/pendingAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/auth/social/connectionsAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/auth/social/emailAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/auth/social/completeAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

Articles and community 23

Read articles, inspect charts and manage your own comments, likes, saves and follows.

  • Public article access can return a preview. Full content can depend on an entitlement or an unlock.
  • Writes use the current account. Reading a public article does not authorize editing another person's comments.
  • List endpoints use their own pagination parameters; there is no universal cursor format.
GET/api/articlesPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/articles/:idPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/articles/:id/unlockAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/articles/:id/chartPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/articles/:id/replayPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/articles/:id/shareAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/articles/:id/likeAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/articles/:id/likeAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/articles/:id/saveAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/articles/:id/saveAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/articles/:id/interactionsPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/articles/:id/likesPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/articles/:id/commentsPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/articles/:id/commentsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

PATCH/api/articles/:id/comments/:commentIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/articles/:id/comments/:commentIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/users/:idPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/users/:id/followAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/users/:id/followAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/users/:id/followersPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/users/:id/followingPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/me/followingAccount required

Market data 7

Read price channels, chart data, market niches, watchlists and sparklines.

  • Use the API hostname. Website helpers with similar paths are separate contracts.
  • Data is stored or cached and can be empty. Check returned timestamps before interpreting freshness.
  • The detailed channels and niches references include response schemas and worked examples.
GET/api/channelsPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/market-intelligence/channel-boardPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/nichesPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/niches/:nicheKeyPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/sparklineAccount required
GET/api/sparkline/publicPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/watchlistAccount required

Strategies 10

Explore public strategies and manage your own strategy collection, forks and runtime settings.

  • Public strategy reads and account-owned strategy reads are different operations.
  • A fork creates an account-owned resource. Use the resulting identifier for subsequent account requests.
  • Runtime-control writes can change execution behavior. Their authorization and lifecycle checks still apply.
GET/api/strategiesPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/strategies/nichesPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/me/strategiesAccount required
GET/api/me/strategies/nichesAccount required
GET/api/strategies/:strategyId/lineagePublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/me/strategies/:strategyId/lineageAccount required
POST/api/strategies/:strategyId/forkAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/strategies/:strategyIdPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/me/strategies/:strategyIdAccount required
POST/api/me/strategies/:strategyId/runtime-controlAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

Backtests 4

Submit historical tests, retrieve job status and browse available test results.

  • Job submission is asynchronous. Retain the returned job identifier and poll the status operation.
  • Submission can consume credits or require an entitlement. A repeated request needs the operation's idempotency handling.
  • Use a fresh request nonce and timestamp for each submission attempt; retain the idempotency key when retrying the same logical submission.
GET/api/chartPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/backtestAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

Replay protection: supply a fresh nonce and a current timestamp for each attempt. See retry rules.

View request schema, response models and examples

Errors and rate limits

GET/api/backtest/:jobIdAccount required
GET/api/backtestsAccount required

Broker connections and orders 11

Connect a supported broker, inspect connection state and read or submit orders for your account.

  • Use the broker catalog to discover available providers and connection methods. Availability depends on configuration.
  • OAuth callbacks complete a previously started connection; they are not independent sign-in shortcuts.
  • Order submission has financial side effects. Confirm the connection environment, symbol, side and quantity before submitting. Documentation does not submit orders.
  • Credentials belong in the protected connection request, never in a URL or a shared example.
GET/api/broker/catalogAccount required
GET/api/broker/oauth/startAccount required
GET/api/broker/oauth/callbackAuthentication flow
Link to this operation

Follow the sign-in or connection flow. Session, verification and callback-state requirements depend on the step. Access guide

View request schema, response models and examples

Errors and rate limits

POST/api/broker/connectAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/broker/statusAccount required
POST/api/broker/disconnectAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/broker/ordersAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

Replay protection: supply a fresh nonce and a current timestamp for each attempt. See retry rules.

View request schema, response models and examples

Errors and rate limits

GET/api/broker/orders/manualAccount required
GET/api/broker/positions/manualAccount required
GET/api/broker/equity/manualAccount required
GET/api/broker/ordersAccount required

Research workspaces 18

Create strategy workspaces, maintain experiment drafts and save research selections.

  • Reads and writes are scoped to the current account. A resource identifier alone grants no access.
  • Save payloads contain structured research state; preserve the resource revision and concurrency fields returned by the application where required.
  • Archive and delete are separate actions. Review the operation before changing a workspace.
GET/api/eureka/experiment-draftsAccount required
POST/api/eureka/experiment-draftsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/experiment-drafts/:draftIdAccount required
PUT/api/eureka/experiment-drafts/:draftIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/eureka/experiment-drafts/:draftIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/research/catalogAccount required
GET/api/eureka/research/inspectionAccount required
GET/api/eureka/saved-researchAccount required
PUT/api/eureka/saved-researchAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/eureka/saved-researchAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-workspacesAccount required
POST/api/eureka/strategy-workspacesAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-workspaces/:strategyIdAccount required
PUT/api/eureka/strategy-workspaces/:strategyIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

PUT/api/eureka/strategy-workspaces/:strategyId/archiveAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/eureka/strategy-workspaces/:strategyIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/ticker-pool/catalogAccount required
GET/api/eureka/ticker-pool/previewsAccount required

Notebooks and execution 12

Read and save notebooks, submit executions and apply their results.

  • Execution creation returns a job resource. Poll its status before applying results.
  • Cancellation and applying an execution are separate operations and require access to the notebook.
  • Worker callbacks use a separate service contract and are not part of this developer reference.
POST/api/eureka/notebooks/:notebookKey/executionsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/notebooks/executions/:jobIdAccount required
POST/api/eureka/notebooks/executions/:jobId/applyAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/eureka/notebooks/executions/:jobId/cancelAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

PATCH/api/eureka/notebooks/executions/:jobIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/eureka/notebooks/:notebookKey/strategy-runsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

Replay protection: supply a fresh nonce and a current timestamp for each attempt. See retry rules.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/notebooksAccount required
GET/api/eureka/notebooks/:notebookKeyAccount required
PUT/api/eureka/notebooks/:notebookKeyAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/eureka/notebooks/:notebookKeyAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-componentsAccount required
POST/api/eureka/notebooks/executions/:jobId/strategy-componentsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

Python research 20

Manage workspace source versions, datasets, assistant proposals and Python run jobs.

  • Check preflight before starting a run; runtime and dataset availability can prevent submission.
  • Datasets and source revisions belong to a workspace. Use identifiers returned for that workspace.
  • Applying a proposal or restoring a version changes the workspace source. Retrieve the proposal or revision first.
  • Run cancellation is separate from deleting a workspace. Worker artifact transport is documented internally.
POST/api/eureka/strategy-workspaces/:strategyId/python-datasets/platformAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/eureka/strategy-workspaces/:strategyId/python-datasetsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-workspaces/:strategyId/python-datasetsAccount required
GET/api/eureka/strategy-workspaces/:strategyId/python-datasets/:datasetVersionIdAccount required
GET/api/eureka/strategy-workspaces/:strategyId/python-datasets/:datasetVersionId/previewAccount required
GET/api/eureka/python-runs/preflightAccount required
POST/api/eureka/python-runsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/python-runsAccount required
GET/api/eureka/python-runs/:runIdAccount required
POST/api/eureka/python-runs/:runId/cancelAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-workspaces/:strategyId/python-sourceAccount required
PUT/api/eureka/strategy-workspaces/:strategyId/python-sourceAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/eureka/strategy-workspaces/:strategyId/python-source/loomy-proposals/:messageId/applyAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-workspaces/:strategyId/python-source/assistant-proposalsAccount required
GET/api/eureka/strategy-workspaces/:strategyId/python-source/assistant-proposals/:proposalIdAccount required
POST/api/eureka/strategy-workspaces/:strategyId/python-source/assistant-proposals/:proposalId/applyAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/eureka/strategy-workspaces/:strategyId/python-source/assistant-proposals/:proposalId/rejectAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-workspaces/:strategyId/python-source/versionsAccount required
GET/api/eureka/strategy-workspaces/:strategyId/python-source/versions/:revisionAccount required
POST/api/eureka/strategy-workspaces/:strategyId/python-source/versions/:revision/restoreAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

Optimisation and validation 30

Prepare optimisation jobs, inspect evidence and manage validation, publication and retargeting.

  • Use compute, preflight and data-window operations before submitting a run. Job completion is asynchronous.
  • Results can include nullable or unavailable evidence. A successful HTTP response does not imply a successful run.
  • Publishing, unpublishing and runtime control change different parts of a strategy's lifecycle.
  • Validation attempt actions use explanation, decision or revision as the action path value.
GET/api/optimisation/runs/:runId/annotationAccount required
PUT/api/optimisation/runs/:runId/annotationAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/optimisation/computeAccount required
GET/api/optimisation/runsAccount required
POST/api/optimisation/runsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

Replay protection: supply a fresh nonce and a current timestamp for each attempt. See retry rules.

View request schema, response models and examples

Errors and rate limits

POST/api/optimisation/runs/preflightAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/optimisation/niches/:nicheId/data-windowAccount required
POST/api/optimisation/data-windowAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/optimisation/strategy-nichesAccount required
GET/api/optimisation/runs/:runIdAccount required
GET/api/optimisation/runs/:runId/strategy-certificationAccount required
GET/api/optimisation/runs/:runId/paper-activityAccount required
POST/api/optimisation/runs/:runId/strategy-runtime-controlAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/optimisation/runs/:runId/holdout-tradesAccount required
GET/api/optimisation/runs/:runId/holdout-price-actionAccount required
POST/api/optimisation/runs/:runId/cancelAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/optimisation/runs/:runId/publishAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/optimisation/runs/:runId/unpublishAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/optimisation/runs/:runId/publish-strategyAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/optimisation/publish-strategy-jobs/:jobIdAccount required
GET/api/optimisation/runs/:runId/validation-attemptsAccount required
POST/api/optimisation/runs/:runId/validation-attemptsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/optimisation/runs/:runId/validation-attempts/:attemptId/:actionAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/optimisation/runs/:runId/validation-attempts/:attemptId/revisions/:revisionIdAccount required
GET/api/optimisation/runs/:runId/entry-filter-decisionsAccount required
POST/api/optimisation/runs/:runId/retargetAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/optimisation/runs/:runId/retargetAccount required
GET/api/optimisation/runs/:runId/retarget-sourceAccount required
GET/api/optimisation/retarget-jobs/:jobIdAccount required
POST/api/optimisation/retarget-jobs/:jobId/cancelAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

Research assistants 35

Manage research conversations, notebook assistance and rule-draft workflows.

  • Conversation and notebook identifiers are account-scoped. Preserve the returned identifiers when continuing a conversation.
  • Some assistant operations require an active provider connection and can return a job or request identifier for polling.
  • Generated proposals are separate from applying changes. Use the corresponding apply operation after review.
  • Assistant connection secrets and MCP transport are covered by separate authentication flows.
POST/api/chatPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/chat/conversationsAccount required
POST/api/chat/conversationsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

PATCH/api/chat/conversations/:conversationIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/chat/conversations/:conversationId/messagesAccount required
GET/api/eureka/loomy/conversationsAccount required
POST/api/eureka/loomy/conversationsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/loomy/conversations/:conversationIdAccount required
POST/api/eureka/loomy/conversations/:conversationId/messagesAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-workspaces/:strategyId/loomy/conversationsAccount required
POST/api/eureka/strategy-workspaces/:strategyId/loomy/conversationsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/strategy-workspaces/:strategyId/loomy/conversations/:conversationIdAccount required
POST/api/eureka/strategy-workspaces/:strategyId/loomy/conversations/:conversationId/messagesAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/assistant/credentialsAccount required
POST/api/eureka/assistant/codex-session/loginAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/assistant/codex-session/login/:loginIdAccount required
DELETE/api/eureka/assistant/codex-sessionAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/assistant/threadsAccount required
POST/api/eureka/notebooks/:notebookKey/assistant/threadsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/notebooks/:notebookKey/assistant/threadAccount required
POST/api/eureka/notebooks/:notebookKey/assistant/thread/messagesAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

DELETE/api/eureka/notebooks/:notebookKey/assistant/threadAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/eureka/notebooks/:notebookKey/assistant/messagesAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/notebooks/:notebookKey/assistant/messages/:requestIdAccount required
POST/api/eureka/idea-assistant/messagesAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/knowledge-assistant/conversationsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/knowledge-assistant/conversationsAccount required
GET/api/knowledge-assistant/conversations/:conversationId/messagesAccount required
PATCH/api/knowledge-assistant/conversations/:conversationIdAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/knowledge-assistant/requests/:requestKeyAccount required
POST/api/knowledge-assistant/messagesAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/knowledge-assistant/proposals/:conversationId/:messageIdAccount required
POST/api/eureka/rules/ideaAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/eureka/rules/capabilitiesAccount required
POST/api/eureka/rules/draftAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

Credits and entitlements 6

Inspect credit balances, gift history, premium state and feature access.

  • Balance reads describe the current account. Gifts and entitlement purchases change account balances.
  • A successful request can still report insufficient balance or an unavailable entitlement through an error response.
  • Sandbox subscription controls are internal and are not supported billing integration endpoints.
GET/api/me/coins/gifts/sentAccount required
GET/api/me/coins/gifts/receivedAccount required
POST/api/me/coins/giftAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

Replay protection: supply a fresh nonce and a current timestamp for each attempt. See retry rules.

View request schema, response models and examples

Errors and rate limits

GET/api/entitlementsAccount required
POST/api/entitlements/advanced-indicatorsAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/me/premiumAccount required

Support and notifications 7

Submit feedback, contact the team, exchange support messages and mark notifications read.

  • Contact and feedback submissions can send messages or create records; they are not read-only operations.
  • Support conversations and notifications are scoped to the current account.
  • Human support availability depends on the deployed configuration.
POST/api/contactPublic access
Link to this operation

This operation permits public requests. Content entitlements and request limits can still apply. Access guide

View request schema, response models and examples

Errors and rate limits

GET/api/human-support/conversations/currentAccount required
GET/api/human-support/conversations/:conversationId/messagesAccount required
POST/api/human-support/conversations/current/messagesAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

GET/api/notificationsAccount required
POST/api/notifications/readAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits

POST/api/product-feedbackAccount required
Link to this operation

Use a signed-in account with permission to access this resource. Access guide

CSRF protection: send an allowed Origin and the matching CSRF cookie and X-CSRF-Token header.

View request schema, response models and examples

Errors and rate limits