intelligence

Generate an intelligence report

Runs a report for the calling organization over the most recent collection cycle and returns it as JSON. Every signal carries its sources, a mention count and a confidence score, and on plans that include evidence, the raw evidence behind that count.

Signal caps per plan: Starter 15, Pro 40, Business 100. An expired trial falls back to a watermarked 3-signal preview with confidence and evidence removed.

Results are filtered to the topics configured on the organization profile. A successful call consumes one unit of the daily quota; a failed generation refunds it. If the underlying data is older than 24 hours the endpoint returns 503 with a Retry-After header rather than serving stale intelligence.

The schema_version query parameter selects the shape of the contract block, not the version of the payload: 1.1 and 1.2 both return the full contract with capabilities and limits, while the default 1.0 returns the compact one. The response reports the schema it actually is, at the top level and inside the contract, and the two always agree.

get/api/v1/intelligence/report

Request

  • Base URL: https://api.gatiflow.io
  • URL: https://api.gatiflow.io/api/v1/intelligence/report
  • Auth: API key in header X-API-Key

Query parameters

schema_versionstring

Shape of the contract block: 1.0, the default, is the compact one; 1.1 and 1.2 add the plan's capabilities and limits.

Headers

X-API-Keystring nullable

The API key, prefix gf_: the credential the ApiKeyAuth scheme declares.

Response

Intelligence report for the calling organization.

schema_versionstring required

The contract shape this payload follows, 1.0 or 1.2.

org_idstring required
planstring required
generated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.