# API: Ask

| Method | Path | What it does | Scope |
|---|---|---|---|
| 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. | `search:read` |
| GET | `/v1/ask/saved` | Your saved questions (answered on schedule and emailed to you) | `search:read` |
| POST | `/v1/ask/saved` | Save a question to be answered daily or weekly and emailed to you | `search:read` |
| DELETE | `/v1/ask/saved/:id` | Stop a saved question | `search: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.

```bash
curl -s -X POST "https://api.closefinch.com/v1/ask" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
```

```js
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)

```bash
curl -s "https://api.closefinch.com/v1/ask/saved" \
  -H "Authorization: Bearer $RA_API_KEY"
```

```js
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

```bash
curl -s -X POST "https://api.closefinch.com/v1/ask/saved" \
  -H "Authorization: Bearer $RA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'
```

```js
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

```bash
curl -s -X DELETE "https://api.closefinch.com/v1/ask/saved/$ID" \
  -H "Authorization: Bearer $RA_API_KEY"
```

```js
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](https://www.closefinch.com/openapi.json). All resources: [API reference](https://www.closefinch.com/docs/api).