Knowledge

Save an unresolved product question or answer correction in the responsible admin's private learning inbox. Product questions follow support ownership; account policy questions go to the account admin. No customer message or email is sent, no model is called, and no answer becomes shared until reviewed.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/knowledge.ask_admin \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "example"
  }'

Over MCP the same operation is the tool knowledge_ask_admin at https://app.chirply.io/api/mcp, same bearer token, same input.

Read automatically captured bug reports, chat corrections, human support replies and unresolved assistant questions for the admin's support team. Private review evidence never becomes public through this read. Platform admins see Chirply-owned items; account admins see their own account or client support queue.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/knowledge.learning_list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "needs_review",
    "offset": 0
  }'

Over MCP the same operation is the tool knowledge_learning_list at https://app.chirply.io/api/mcp, same bearer token, same input.

Read one authorized learning item's private source evidence, current answer and last 20 review decisions. Allows an admin to verify a proposed correction before reusing it. Does not publish guidance, contact customers or change report statuses.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/knowledge.learning_read \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool knowledge_learning_read at https://app.chirply.io/api/mcp, same bearer token, same input.

Publish an admin-verified reusable answer, dismiss an item, require a code correction, or retire previously approved guidance. Publication changes what future users and AI chats read; global publication is platform-admin-only, and commercial terms must be corrected in code. Records an immutable review with evidence and expiry; sends no customer message and spends no money.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/knowledge.learning_review \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "version": 1,
    "decision": "publish",
    "verification": "example"
  }'

Over MCP the same operation is the tool knowledge_learning_review at https://app.chirply.io/api/mcp, same bearer token, same input.

Read the signed-in person's latest 50 clarification requests in the active account, including review status. Private evidence from other users is excluded. Returns an empty list for API keys without a person; does not contact anyone or change records.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/knowledge.my_questions \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool knowledge_my_questions at https://app.chirply.io/api/mcp, same bearer token, same input.

Read a complete product help article, including setup instructions and troubleshooting. Uses the same knowledge base users browse in Help & setup. Read-only, with no AI charge or account changes; hides vendor pricing under white-label brands.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/knowledge.read \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example"
  }'

Over MCP the same operation is the tool knowledge_read at https://app.chirply.io/api/mcp, same bearer token, same input.

Browse or search product help guides and references by topic and category. Returns article summaries and links, with pagination. Reads documentation only; does not change records, send messages or incur AI charges. Vendor pricing articles are hidden for white-label brands.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/knowledge.search \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "",
    "area": ""
  }'

Over MCP the same operation is the tool knowledge_search at https://app.chirply.io/api/mcp, same bearer token, same input.