← Receivers

playbook:get

playbook family

Get the caller's playbook entries (optionally scoped to one course)

Effect
ask
Awaits an outcome — the call returns the response below.
Caller
public
The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost
free
What one call costs, so you can budget before acting.
Reversible
yes
The effect can be undone by a later call.
Idempotent
yes
Safe to retry as-is.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/ask/playbook:get \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "course": <string>, "slug": <string>, "workspace": <string> }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

  • course string optional
  • slug string optional
  • workspace string optional

Response

What comes back from the call.

  • entries object[]

Traffic

Every call to playbook:get, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names playbook:get, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

UI 6
  • one.ie/web/src/components/company/PlaybookSection.tsx:23
  • one.ie/web/src/components/courses/PlaybookEntryEditor.tsx:21
  • one.ie/web/src/components/courses/PlaybookView.tsx:26
  • one.ie/web/src/pages/u/[slug]/learn/[course]/[lesson].astro:59
  • one.ie/web/src/pages/u/[slug]/learn/playbook.astro:8
  • one.ie/web/src/pages/u/[slug]/playbook.astro:47
Agent runtime 1
  • channels/src/tools/courses.ts:98
→

Answered by

playbook:get one.ie/web/src/lib/resolvers/courses.ts:199 Dispatched through POST /api/ask/playbook:get, after the envelope validates the payload.

playbook family · 2 more

playbook:promoteplaybook:save
JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "course": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "workspace": {
      "type": "string"
    }
  }
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    }
  }
}