Start a BotArmor audit
start_auditCrash-test chatbots and AI agents with multi-level audits, then retrieve status and actionable reports containing exact prompt improvements.
Instructions
Crash-test a chatbot or AI agent with BotArmor: up to 12 attack levels (fake manager, angry customer, fake lawyer, prompt injection, role-play, phishing, AI disclosure under the EU AI Act, invented facts...) plus level 13 for agents with tools, 5 adaptive sessions each. Two modes. target_type 'prompt' (default when no endpoint_url): BotArmor plays the agent's system prompt on its own model; use it for an agent running on localhost or not deployed yet, reading the system prompt from the code. target_type 'openai-compatible' or 'webhook': a live audit of a running bot at a public https URL; requires authorization_confirmed: true, only after the user confirmed they own the bot or have written permission. Returns the audit id; an audit takes 5 to 20 minutes, then use get_audit_status and get_audit_report. Uses one audit credit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Report language, default en. | |
| name | No | Name shown in the report. | |
| model | No | openai-compatible only: the model name sent in the request body. | |
| levels | No | Subset of levels; default all 12 (plus 'agency' when tools are declared). | |
| headers | No | Headers the target needs, e.g. {"Authorization": "Bearer ..."}. A credential header is stored encrypted by BotArmor. | |
| min_grade | No | Pass threshold shown by get_audit_status, default B. | |
| target_type | No | Default: 'webhook' when endpoint_url is given, else 'prompt'. | |
| endpoint_url | No | Public https URL of the running agent (live audits only). localhost cannot be reached from BotArmor's servers. | |
| body_template | No | webhook only: JSON body with {{input}} (current message), "{{history}}" or "{{messages}}". Default {message: "{{input}}", session_id: "{{session_id}}"}. | |
| response_path | No | webhook only: dot path to the reply text in the response JSON, e.g. data.reply. | |
| system_prompt | Yes | The agent's system prompt / instructions, as in its code. For a live audit it is also the rulebook the judge checks answers against. | |
| authorization_confirmed | No | Live audits only. true = the user confirmed they own the bot or hold the owner's written permission to test it. |