Skip to content

API reference

API: Ask

Markdown version

MethodPathWhat it doesScope
POST/v1/askAsk a question in plain words. The answer comes as short claims, each citing the records, conversations, documents or memory it rests on, with how fresh each source is. Only what you can see is used.search:read
GET/v1/ask/savedYour saved questions (answered on schedule and emailed to you)search:read
POST/v1/ask/savedSave a question to be answered daily or weekly and emailed to yousearch:read
DELETE/v1/ask/saved/:idStop a saved questionsearch:read

Examples

POST /v1/ask

Ask a question in plain words. The answer comes as short claims, each citing the records, conversations, documents or memory it rests on, with how fresh each source is. Only what you can see is used.

curl -s -X POST "https://api.closefinch.com/v1/ask" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
const res = await fetch(`https://api.closefinch.com/v1/ask`, {
  method: "POST",
  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();

GET /v1/ask/saved

Your saved questions (answered on schedule and emailed to you)

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

POST /v1/ask/saved

Save a question to be answered daily or weekly and emailed to you

curl -s -X POST "https://api.closefinch.com/v1/ask/saved" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
const res = await fetch(`https://api.closefinch.com/v1/ask/saved`, {
  method: "POST",
  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();

DELETE /v1/ask/saved/$ID

Stop a saved question

curl -s -X DELETE "https://api.closefinch.com/v1/ask/saved/$ID" \
  -H "Authorization: Bearer $RA_API_KEY"
const res = await fetch(`https://api.closefinch.com/v1/ask/saved/${id}`, {
  method: "DELETE",
  headers: { authorization: `Bearer ${process.env.RA_API_KEY}` },
});
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.