---
title: "Look up how Custodo works"
method: GET
path: "/api/v1/rest/manual"
tags: ["Platform"]
---

# Look up how Custodo works

`GET /api/v1/rest/manual`

## Request

- Base URL: `https://api.custodo.ai`
- URL: `https://api.custodo.ai/api/v1/rest/manual`
- Auth: HTTP bearer

Searches the Custodo user manual — the book the app shows under Impostazioni → Manuale utente — and returns the passages that answer a question about USING Custodo: where a function is, how to do something, what a button, a status or a message means, what a package includes. Call it BEFORE answering any such question and answer from these passages only, with the manual’s own names for menus and buttons; give the person the `url` of the passage you used. It reads no organisation data. When it finds nothing, the manual does not cover the question: say so instead of describing screens you have not read.

**Examples**

- Come si attiva un modulo?
  `GET /api/v1/rest/manual?question=come+si+attiva+un+modulo`
- How do I connect a PEC mailbox?
  `GET /api/v1/rest/manual?question=how+do+I+connect+a+PEC+mailbox&lang=en`

## Query parameters

- `question` string, required
- `lang` 'it' | 'en'

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

Done. `data` is the tool’s own answer.

- RestResult
  - `ok` true, required
  - `data` unknown, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)