> ## 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.

# Fetch Brief

> Fetch one Monitoring Brief: status, the original input, the structured `document` (Monitoring Brief content), `citations`, the evidence `appendix`, and report URLs. A still-running Brief is reconciled first. Requires a plan with Briefs access.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/briefs/{id}
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/{id}:
    get:
      tags:
        - Briefs
      summary: Fetch Brief
      description: >-
        Fetch one Monitoring Brief: status, the original input, the structured
        `document` (Monitoring Brief content), `citations`, the evidence
        `appendix`, and report URLs. A still-running Brief is reconciled first.
        Requires a plan with Briefs access.
      operationId: get-brief-v2
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Brief id from create or list.
      responses:
        '200':
          description: The Brief.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  title:
                    type: string
                  brief_type:
                    type: string
                  status:
                    type: string
                    description: queued → generating → building → ready, or failed.
                  created_at:
                    type: string
                  updated_at:
                    type: string
                  error_message:
                    type: string
                    nullable: true
                  input:
                    type: object
                    nullable: true
                  document:
                    type: object
                    description: Structured Monitoring Brief content.
                    nullable: true
                  citations:
                    type: array
                    items:
                      type: object
                  appendix:
                    type: object
                    description: Evidence chain / tool-call ledger.
                    nullable: true
                  public_url:
                    type: string
                    nullable: true
                  web_url:
                    type: string
              examples:
                ready:
                  value:
                    id: brief_123
                    status: ready
                    title: Red Sea maritime disruption watch
                    brief_type: monitoring_brief
                    created_at: '2026-06-08T14:00:00Z'
                    updated_at: '2026-06-08T14:08:00Z'
                    error_message: null
                    input:
                      time_window: 7d
                      audience: executive
                    document:
                      bottom_line: Disruption risk remains elevated.
                    citations: []
                    appendix: []
                    public_url: null
                    web_url: https://gdeltcloud.com/briefs/brief_123
        '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`).
        '404':
          description: Brief not found (or not owned by the caller).
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl "https://gdeltcloud.com/api/v2/briefs/$BRIEF_ID" \
              -H "Authorization: Bearer $GDELT_CLOUD_API_KEY"
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````