> ## Documentation Index > Fetch the complete documentation index at: https://docs.gdeltcloud.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Brief > Create and kick off a Monitoring Brief. Returns **202 immediately** — a Brief takes ~5–10 minutes; poll `GET /api/v2/briefs/{id}` for status and content. Requires a plan with Briefs access; metered separately from query units. ## OpenAPI ````yaml /api-reference/openapi-v2.json post /api/v2/briefs openapi: 3.0.3 info: title: GDELT Cloud API v2 version: 2.0.0 description: >- Clean v2 REST API for generated GDELT Cloud structured Events, clustered Stories, linked Entities, summaries, admin1 discovery, significance ranking, and paginated article evidence. Event significance is a family-scoped weighted blend, renormalized so every event family spans a true 0-1: each event's raw total is divided by the maximum its own family can reach (Conflict 1.00, CAMEO+ POLITICAL 0.90, other CAMEO+ domains 0.65). All events: Goldstein severity 0.25, article evidence 0.05, confidence 0.05. Conflict only: fatalities 0.55 (log-scaled by body count) and civilian targeting 0.10. CAMEO+ only: magnitude 0.20, systemic importance 0.15, propagation potential 0.10, market sensitivity 0.10. When magnitude is unmeasured its term AND its 0.20 weight are both dropped. The four CAMEO+ metrics are rubric scores produced by published formulas - ordinal ranking signals, not measurements, probabilities, or predicted price moves. goldstein_scale is one canonical public metric, populated for Conflict Events and CAMEO+ POLITICAL Events where meaningful. Story linked_event_count is a Story-to-Event link aggregate, not a distinct Event total. servers: - url: https://gdeltcloud.com description: Production - url: http://localhost:3000 description: Local development security: - ApiKeyAuth: [] tags: - name: Events description: Coded CAMEO+ / conflict events — search, fetch, and summarize. - name: Stories description: Clustered narratives (stories) and their articles. - name: Entities description: >- People & organizations — resolve a name to an entity, then fetch its profile and tone. - name: Geography description: Admin-1 geography lookups. - name: Energy description: Global Energy Monitor assets + ownership registry. - name: Facilities description: >- Unified physical-asset directory — GEM energy assets + World Port Index ports + Epoch AI data centers on one keyed surface, resolved to spine owners. Plan-gated (Analyst plan and up). - name: Screening and Reference description: >- Restricted-party lists, screening, and ownership-chain exposure. Plan-gated (`can_use_screening` / `can_use_exposure`). - name: China description: >- China overseas development finance (AidData GCDF). Plan-gated (`can_use_china`). - name: Media Intelligence description: >- Entity tone (`can_use_tone`) and Share of Voice (`can_use_share_of_voice`) are plan-gated. Social signal remains an admin-only preview. - name: Filings description: >- SEC EDGAR filings, XBRL financials, and AI-extracted relations. Requires a plan with SEC filings access (`can_use_filings`) — the Corporate & Supply Chain plan and above. - name: Macro Finance description: >- FRED economic time series (catalog, point-in-time observations, releases). Plan-gated (`can_use_macro`). - name: Maritime description: >- AIS-derived vessel-flow signals across maritime chokepoints — chokepoint transits, last-known vessel positions, carriers, dwell, and AIS-dark gaps. Plan-gated (`can_use_maritime`). - name: Briefs description: Source-backed monitoring briefs. paths: /api/v2/briefs: post: tags: - Briefs summary: Create Brief description: >- Create and kick off a Monitoring Brief. Returns **202 immediately** — a Brief takes ~5–10 minutes; poll `GET /api/v2/briefs/{id}` for status and content. Requires a plan with Briefs access; metered separately from query units. operationId: create-brief-v2 requestBody: required: true content: application/json: schema: type: object required: - scope_text properties: scope_text: type: string minLength: 8 maxLength: 2400 description: >- One or two plain sentences: the situation, where it is, who/what is affected, and the decision it informs. example: >- Monitor Red Sea maritime disruption risk to shipping across Yemen, the Red Sea, and the Gulf of Aden. time_window: type: string enum: - 6h - 24h - 72h - 7d - 30d default: 24h description: Recent window the Brief analyses. baseline_window: type: string enum: - 7d - 14d - 30d description: Earlier comparison window for change detection. audience: type: string enum: - executive - analyst - operator default: executive depth: type: string enum: - skim - standard - detailed default: standard countries: type: array items: type: string description: ISO-3 country codes to scope the Brief. example: - YEM - SAU regions: type: array items: type: string sectors: type: array items: type: string search_topics: type: array items: type: string description: Free-text focus terms/phrases that bias retrieval. example: - port congestion - tanker insurance actors: type: array items: type: string description: Named actors to emphasize. example: - Houthi - Maersk entities: type: array items: type: string description: Named people or organizations to emphasize. locations: type: array items: type: string description: Plain-English sub-country locations. assets: type: array items: type: string description: Named facilities or infrastructure. public_link: type: boolean default: false description: When true, also mint a public shareable report URL. title: type: string description: Optional; auto-generated from scope_text when omitted. brief_type: type: string default: monitoring_brief description: >- Optional; defaults to monitoring_brief, the only generally-available type. enum: - monitoring_brief responses: '202': description: Brief generation started. content: application/json: schema: type: object properties: id: type: string status: type: string example: queued brief_type: type: string title: type: string created_at: type: string web_url: type: string public_url: type: string nullable: true message: type: string examples: accepted: value: id: brief_123 status: queued brief_type: monitoring_brief title: Red Sea maritime disruption watch created_at: '2026-06-08T14:00:00Z' web_url: https://gdeltcloud.com/briefs/brief_123 public_url: null message: Brief generation started. '401': description: Missing or invalid API key. '403': description: >- Briefs are not available on your plan (`BRIEF_ACCESS_DENIED`), or the included Brief allotment is exhausted (`BRIEF_LIMIT_REACHED`). security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl -X POST "https://gdeltcloud.com/api/v2/briefs" \ -H "Authorization: Bearer $GDELT_CLOUD_API_KEY" \ -H "Content-Type: application/json" \ -d '{"scope_text":"Monitor Red Sea maritime disruption risk across Yemen and the Gulf of Aden.","time_window":"7d","baseline_window":"30d","audience":"executive","countries":["YEM","SAU"]}' components: securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: gdelt_sk_... description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.' ````