Knowledge

Search your playbooks and documents, read them, and find who knows about a topic.

Everything here needs knowledge:read, and only returns what the key's owner can open in the app. To write documents, see Documents.

Answer a question from your documents

  1. 1

    Search

    POST /v1/knowledge/search finds the passages that best answer a question. Ask a whole question: search matches meaning, not just words.

    curl -X POST https://developers.playbookops.ai/v1/knowledge/search \
      -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY" -H "Content-Type: application/json" \
      -d '{"query": "How do we handle refunds over $500?"}'
    
    {
      "data": [
        {
          "document_id": "…",
          "title": "Refunds and credits",
          "passage": "Refunds over $500 need a manager's approval…",
          "similarity": 0.87,
          "playbook_name": "Support",
          "url": "https://app.playbookops.ai/playbooks/…"
        }
      ],
      "credits_used": 1
    }
    
  2. 2

    Read the document

    If the passage isn't enough, GET /v1/documents/DOCUMENT_ID returns the whole document as Markdown. Documents over 24,000 characters are cut off, with truncated: true; add ?full=true for all of it.

  3. 3

    Find someone to ask

    When the documents don't cover it, POST /v1/knowledge/who-knows with a topic returns the people who know about it, and why.

    curl -X POST https://developers.playbookops.ai/v1/knowledge/who-knows \
      -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY" -H "Content-Type: application/json" \
      -d '{"topic": "payroll"}'
    
Search and who knows use AI credits

Each call uses 1 AI credit from your organization, and says so in credits_used. Everything else on this page is free. See limits and credits.

Browse

  • GET /v1/playbooks?search=onboarding lists playbooks, with how many documents each has.
  • GET /v1/content?kinds=document&playbook_id=PLAYBOOK_ID lists documents, files, flowcharts, videos and more, newest first.

Reference

ActionEndpointMCP tool
SearchPOST /v1/knowledge/searchsearch_knowledge
Who knowsPOST /v1/knowledge/who-knowswho_knows
Read a documentGET /v1/documents/{id}read_document
Create a documentPOST /v1/playbooks/{id}/documentscreate_document
Change a documentPATCH /v1/documents/{id}update_document
PlaybooksGET /v1/playbookslist_playbooks
ContentGET /v1/contentlist_content

Every parameter is in the API reference.