Skip to content

Resolve a playbook

Canonical tool: occam_playbook_resolve

Look up the saved extraction recipe (playbook/genome) for a URL or host: content selectors, knowledge schema, agent notes, and signature integrity status relative to your local key. Read-only.

Signature status is integrity vs your local key — not author identity, not a trusted registry, and not proof of recipe quality.

When to use

See Playbooks for resolution order and v1 vs v2 semantics.

Parameters

Parameter Type Default Required Description
url string — yes HTTP(S) URL, search handle, or bare hostname
schema_version string 1.0 no Playbook schema version
include_lessons bool false no Export lessons[] from local tier (max 10)
fetch_site_genome bool false no Fetch https://{host}/.well-known/agent-genome.v1.json

Returns

Success envelope:

  • ok: true, url, matchedHost, playbookId, schemaVersion, provenance, sourcePath
  • contentSelectors[]?, preferredBackend?, agentNotes?, pageClass?
  • genome? / knowledgeSchema?
  • signature? — {present, status, sigVersion?, keyId?, score?, passesGate?}
  • status ∈ unsigned | verified | invalid | wrong_key | key_mismatch | unsupported_version
  • sigVersion — 1, 2, or null when unsigned
  • v1: body signed; gate fields in provenance are unsigned
  • v2: body + keyId, signedAt, gate snapshot tamper-evident — still heuristic, not quality proof

Failure envelope: ok: false, playbook_not_found, etc.

Failure codes

invalid_arguments, playbook_not_found. See failure codes.

Example

{ "url": "https://nginx.org/en/docs/", "include_lessons": true }

{
  "ok": true,
  "playbookId": "nginx.org",
  "signature": {
    "present": true,
    "status": "verified",
    "sigVersion": 2,
    "keyId": "k1:…",
    "passesGate": true,
    "score": 86
  }
}