GetMint API DocApiMini audit
Generate complete mini audit report asynchronously
Creates a background job to generate a comprehensive brand intelligence report. Returns immediately with a jobId. Poll GET /domains/mini-audit/jobs/:jobId to check status and get results.
X-API-Key<token>
API Key for programmatic access
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/domains/mini-audit/generate-report" \ -H "Content-Type: application/json" \ -d '{ "topicName": "Payment Processing", "name": "Stripe", "websiteUrl": "https://example.com", "market": "US", "projectLanguage": "en", "prompts": { "alignment": { "global": [ [ null ] ], "withAttributes": [ [ null ] ] }, "sentiment": [ "How do users feel about..." ], "competition": [ "Compare the brand with competitors..." ], "visibility": [ "What are the best solutions for..." ] } }'{
"jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "pending"
}Generate prompts for mini audit POST
Generate analysis prompts based on brand and topic information. Returns prompts for visibility, competition, sentiment, and alignment analysis. Use isOnboarding=true for 5 visibility prompts, false for 8.
Get mini audit job status and result GET
Poll this endpoint to check job progress. When status is "completed", the result field contains the full report.