API documentation
Integrate Dodam AI inspection into your own tools.
On this page
- 1OverviewA small, predictable REST API. Every response is JSON with camelCase keys; job creation is multipart/form-data so you can upload images directly.
- 2AuthenticationRequests are authenticated with an organization API key sent as a Bearer token. Keys never expire but can be revoked at any time.
- 3Quotas & usageEach organization has a monthly quota of inspection units. Reads are free; inspections and re-inspections consume units.
- 4Markets & rulesRule sets are composed per country and platform: image spec, title rule, prohibited or risky expressions, IP references and required information.
- 5Create an inspectionUpload the detail-page images and listing text in one multipart request. The engine runs synchronously and the response already contains the findings.
- 6Get resultsList inspections with cursor pagination, fetch a single inspection with signed image URLs, or page through findings per round.
- 7Findings modelEvery issue is a finding with a category, a severity, a stable rule code, evidence, a suggestion and, when possible, an executable fix action.
- 8Apply fixes & re-inspectSend the ids of auto-fixable findings to apply them. Dodam creates a new version of each touched image, updates the text and runs a new round.
- 9Outputs & downloadsRetrieve the final version of every image, the report and a ZIP bundle. Downloads are logged in the inspection's download history.
- 10ErrorsErrors use conventional HTTP status codes and a JSON body with a stable machine-readable code.
- 11OpenAPIThe whole API is described by an OpenAPI 3.1 document that you can import into Postman, Insomnia or an SDK generator.