Skip to content

API reference

API: Knowledge base

Markdown version

MethodPathWhat it doesScope
GET/v1/kbThe company knowledge base: sections (positioning, products, proof points, voice, ICP, exclusions, playbooks…) and the suggested ones not written yetknowledge:read
GET/v1/kb-proposalsText offered to knowledge base sections from proof points and interview synthesesknowledge:read
POST/v1/kb-proposals/:id/acceptAccept a proposal: its text is added to the section as a new version (owners, from the app) (web app only)settings:write
POST/v1/kb-proposals/:id/dismissDismiss a proposal (nothing is written) (web app only)settings:write
DELETE/v1/kb/:keyArchive a section (its revisions stay)settings:write
GET/v1/kb/:keyOne section with its revisionsknowledge:read
PUT/v1/kb/:keyWrite a section (owners: every agent reads it; each save is a new version; send the version you edited)settings:write

Examples

GET /v1/kb

The company knowledge base: sections (positioning, products, proof points, voice, ICP, exclusions, playbooks…) and the suggested ones not written yet

curl -s "https://api.closefinch.com/v1/kb" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/kb`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

GET /v1/kb-proposals

Text offered to knowledge base sections from proof points and interview syntheses

curl -s "https://api.closefinch.com/v1/kb-proposals" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/kb-proposals`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

DELETE /v1/kb/$KEY

Archive a section (its revisions stay)

curl -s -X DELETE "https://api.closefinch.com/v1/kb/$KEY" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/kb/${key}`, {
  method: "DELETE",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

GET /v1/kb/$KEY

One section with its revisions

curl -s "https://api.closefinch.com/v1/kb/$KEY" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/kb/${key}`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
const data = await res.json();

PUT /v1/kb/$KEY

Write a section (owners: every agent reads it; each save is a new version; send the version you edited)

curl -s -X PUT "https://api.closefinch.com/v1/kb/$KEY" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
const res = await fetch(`https://api.closefinch.com/v1/kb/${key}`, {
  method: "PUT",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}`, "content-type": "application/json" },
  body: JSON.stringify({}), // fields: see the OpenAPI schema
});
const data = await res.json();

Request and response schemas: https://www.closefinch.com/openapi.json. All resources: API reference.

Send feedback

Tell us what's broken, confusing or missing on this page, or an idea. It goes to the team that builds the product.

Please don't include passwords or card numbers.
Only to reply about this. Never added to any mailing list.