Request brief
request_briefStart a competitive-intelligence brief for one company. Returns at once with a brief_id; generation takes 3 to 6 minutes. Then call get_brief(brief_id) after poll_after_seconds. Cost: one credit is held now and spent only if the brief is ready with at least one item. An empty or failed brief costs nothing. Pass the same idempotency_key to retry safely: it returns the original brief instead of starting a second one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | The company's own website: a domain such as acme.com, or a URL on it. Not a LinkedIn or directory page. | |
| lookback_days | No | Days of news to cover, 1 to 7. Defaults to 7. The search reaches 2 days further back, because news is often published a day or more after the event; the brief states the exact date range it covers. | |
| idempotency_key | No | Optional. Reusing the same key with the same parameters returns the original brief and spends nothing new, for 24 hours. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| brief_id | Yes | ||
| duplicate | Yes | True when this returned an earlier request instead of starting a new brief. | |
| credits_remaining | Yes | Credits available after this request: the balance minus credits held by briefs in progress. | |
| poll_after_seconds | Yes | Seconds to wait before calling get_brief. 0 when the brief is already settled. |