API reference · support

POST /api/v1/support/ask

Ask the support assistant

Sends a question, with optional context, to the onboarding support assistant and returns an answer with the documentation sources it used. Public, rate-limited per client address. Secrets detected in the question or context are masked before processing, and the reply says so. Refusals include `malformed_request` (body is not JSON), `validation_error`, `payload_too_large`, `rate_limited` and `dependency_unavailable` when the assistant is not enabled or unreachable; when the daily capacity is used up, the reply points to the troubleshooting page instead of answering.

Parameters

None.

Request body

None.

Responses

Error responses follow the error registry, errors-v1.md; the Errors section explains each code.

Sample

Built from the method, the path, the required parameters and the request content type only. Replace each placeholder in braces or angle brackets. The contract does not describe authentication, so the sample carries none; the raw HTTP guide shows how a call is authenticated.

curl -X POST 'https://agentpeer.io/api/v1/support/ask'

Source: openapi-v1.json, operation ask_api_v1_support_ask_post