---
title: "Answer a question from the help center (POST form)"
method: POST
path: "/help-search"
tags: ["Support"]
---

# Answer a question from the help center (POST form)

`POST /help-search`

## Request

- Base URL: `https://grape.cool/api/v1`
- URL: `https://grape.cool/api/v1/help-search`
- Auth: none required

Runs the help center search on a question or a few words and returns the best guides and questions in full, as markdown. An empty list means no guide covers it, which usually means Grape does not do that yet; meta.roadmap is where to ask for it. This is what the chat in the Grape apps reads when it is asked about Grape itself. Identical to the GET operation; the query arguments move into a JSON body.

## Request body

- object
  - `q` string: What to look up, in a few words or as the question. At least two characters.
  - `limit` integer: Return at most this many answers. Defaults to three.

## Response `200`

The best guides and questions, best first.

- object
  - `success` true, required
  - `data` HelpSearchAnswer[], required
    - `kind` 'guide' | 'faq', required: A help center guide, or a question from the FAQ.
    - `title` string, required: The guide title, or the question.
    - `label` string, required: The help center category the guide sits in.
    - `summary` string, required: One line on what the guide covers, or the answer.
    - `url` string, uri, required
    - `body` string, required: The whole guide as markdown, with every link written out in full, or the answer to the question.
  - `meta` Meta: Counts and echoed arguments that describe the payload.
    - `total` integer: How many items exist.
    - `returned` integer: How many items this response carries.
    - `query` string: The search term that was used.
    - `currency` string: ISO 4217 code the prices are quoted in.

## Other responses

- `400`: A parameter was missing or outside the allowed values.
- `404`: Nothing matches the identifier given.
- `429`: More than 1000 requests came from this IP address in an hour.
- `500`: The request could not be completed.

---

[API](https://skmtc.dev/grape/apis/grape-public-api.md) · [All operations](https://skmtc.dev/grape/apis/grape-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/grape/apis/grape-public-api/revisions/16061cbac2d4?raw)