Capabilities

help-center.search

Search public Receiptor help-center documentation for setup, troubleshooting, and product how-to answers. Returns grouped article results with the most relevant snippets.

post/capabilities/help-center.search

Request

  • Base URL: https://developer.api.receiptor.ai/v1
  • URL: https://developer.api.receiptor.ai/v1/capabilities/help-center.search
  • Auth: one of:
    • API key in header x-receiptor-api-key
    • HTTP bearer

Request body

querystring required

Natural language help-center query such as 'connect gmail', 'imap not connecting', or 'does receiptor send emails'.

limitinteger

Maximum number of help-center articles to return.

snippetsPerResultinteger

Maximum number of matching snippets to keep for each help-center article.

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}

Changes

No recorded changes to this operation across all 12 revisions of this API.