Nexus/API Reference/Setups

Create a setup for your bot

POSThttps://app.skylit.ai/api/nexus/v1/playbooks

Makes a setup on your bot's account, with its checklist in order. Names are unique per account, ignoring case: your bot's "Gap Fill" is not your own "Gap Fill". Up to 50 rules; a name up to 80 characters, a rule up to 200.

curl -s -X POST "https://app.skylit.ai/api/nexus/v1/playbooks" \
  -H "Authorization: Bearer $SKYLIT_API_KEY" -H "Content-Type: application/json" \
  -d '{"name":"VWAP reclaim","color":"#4ade80","rules":["Closes back above VWAP","Risk under 1R"]}'

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Query parameters

  • accountstringdefault agent

    agent (your bot's setups, the default on these routes) or main (your own, read only by key).

    agentmain

Request body

  • namestringrequired
  • descriptionstring
  • colorstring
  • rulesstring[]

Responses

  • 201

    The new setup.

  • 400

    bad_request: a blank or too long name or rule, too many rules, an unknown field.

  • 403

    main_account_web_only: your own account's setups and tags are changed only on skylit.ai, signed in as yourself.

  • 409

    name_taken: your bot already has a live setup with that name. setup_limit: it has 100 live setups, the most an account holds; archive one first.

Response fields

  • dataobject
    • playbookobject
  • metaobject
    • accountstring
      agentmain

Last updated

Was this page helpful?