Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

GDELT Cloud API key. Send as Authorization: Bearer gdelt_sk_....

Body

application/json
scope_text
string
required

One or two plain sentences: the situation, where it is, who/what is affected, and the decision it informs.

Required string length: 8 - 2400
Example:

"Monitor Red Sea maritime disruption risk to shipping across Yemen, the Red Sea, and the Gulf of Aden."

time_window
enum<string>
default:24h

Recent window the Brief analyses. How far back the brief looks for evidence. Full value list: https://docs.gdeltcloud.com/reference/enums#brief_time_window

Available options:
6h,
24h,
72h,
7d,
30d
baseline_window
enum<string>

Earlier comparison window for change detection. The comparison period a reading is called normal or abnormal against. It is separate from time_window on purpose: a 24h brief still needs weeks of history to know what 24 hours of this looks like. Full value list: https://docs.gdeltcloud.com/reference/enums#brief_baseline_window

Available options:
7d,
14d,
30d
audience
enum<string>
default:executive

Who the brief is written for. It changes the register and what is foregrounded, never the evidence. Full value list: https://docs.gdeltcloud.com/reference/enums#brief_audience

Available options:
executive,
analyst,
operator
depth
enum<string>
default:standard

How much the brief does. Not a quality setting — a skim is complete and cited, just narrower. Distinct from the numeric depth on the entity-hierarchy endpoint, which counts ownership levels. Full value list: https://docs.gdeltcloud.com/reference/enums#brief_depth

Available options:
skim,
standard,
detailed
countries
string[]

ISO-3 country codes to scope the Brief.

Example:
regions
string[]
sectors
string[]
search_topics
string[]

Free-text focus terms/phrases that bias retrieval.

Example:
actors
string[]

Named actors to emphasize.

Example:
entities
string[]

Named people or organizations to emphasize.

locations
string[]

Plain-English sub-country locations.

assets
string[]

Named facilities or infrastructure.

When true, also mint a public shareable report URL.

title
string

Optional; auto-generated from scope_text when omitted.

brief_type
enum<string>
default:monitoring_brief

Optional; defaults to monitoring_brief, the only generally-available type.

Available options:
monitoring_brief

Response

Brief generation started.

id
string
status
string
Example:

"queued"

brief_type
string
title
string
created_at
string
web_url
string
public_url
string | null
message
string