elmo
Sign up

Create a report

POST
/reports

Create a new AI Share of Voice report and queue it for generation. The report will evaluate the brand across multiple AI engines (ChatGPT, Claude, Google AI) using generated and optional custom prompts.

Requires an instance admin key; organization keys receive 403.

Authorization

BearerAuth
headerAuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

Request Body

application/json
  1. body
brandName*string

The brand name to analyze

Length1 <= length
brandAliases?array<string>

Other names the brand goes by (spellings, abbreviations, product names). A mention of any of them counts as a brand mention.

Itemsitems <= 10
brandWebsite*string

The brand's website — a domain (nike.com) or a full URL. A URL with a path (e.g. https://www.nike.com/golf) scopes the analysis to that page; mentions are tracked against its domain either way.

Length1 <= length
manualPrompts?array<string>

Optional list of custom prompts to include in the report

Response Body

Report created and queued for generation

application/json
  1. response
reportId*string

Unique identifier for the created report

Formatuuid
status*"pending"

Initial report status

Value in"pending"
brandName*string
brandAliases*array<string>
brandWebsite*string
createdAt*string
Formatdate-time
Example Request
curl -X POST 'https://app.elmohq.com/api/v1/reports' \
  -H 'Content-Type: application/json' \
  -d '{
  "brandName": "string",
  "brandWebsite": "string"
}'
Example Response
{
  "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9",
  "status": "pending",
  "brandName": "string",
  "brandAliases": [
    "string"
  ],
  "brandWebsite": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}