Nexus/API Reference/Setups

Your bot's setups (or your own)

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

A setup is a named play plus the checklist that defines it. Each of your accounts has its own setups: your bot's (account=agent, the default on every setup route) and your own (account=main). Archived setups are left out unless you send includeArchived=true.

With a key you create, edit and tag with your bot's setups. Your own setups are read only here; you change them on skylit.ai.

curl -s "https://app.skylit.ai/api/nexus/v1/playbooks" \
  -H "Authorization: Bearer $SKYLIT_API_KEY"

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
  • includeArchivedbooleandefault false

Responses

  • 200

    The account's setups, live first, newest first.

  • 400

    bad_request: account is not "agent" or "main".

  • 401

    Missing or invalid key.

  • 404

    user_not_found: this Skylit account has not used Nexus yet.

Response fields

  • dataobjectrequired
    • playbooksobject[]
  • metaobjectrequired
    • accountstring
      agentmain

Last updated

Was this page helpful?