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

# AI models

> Epoch model observations with terminal entity IDs, separately resolved participants, source roles and publication coverage.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/epoch/models
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: Situations
    description: >-
      One real-world occurrence as the Stories and coded Events that belong to
      it — stored, adjudicated membership (`meta.situation_source: curated`) or
      a walked neighbourhood around a Story. Discovery, detail, four
      independently paged member lists, and the only write on the core surface
      (5 QU with an Idempotency-Key).
  - name: Entities
    description: >-
      People & organizations — resolve a name to an entity, then fetch its
      profile and tone. Also the publication activity journal
      (/api/v2/activity): observed evidence of what was published about
      identities and records — committed batches only, cursor-paged, never
      source intake.
  - name: Unified Search
    description: >-
      One fuzzy lookup across every id-space — start here with a name, take the
      entity id, then reuse it on every other surface. This is the resolver the
      rest of the API assumes you called first.
  - name: Media Intelligence
    description: >-
      Press-coverage tone over time and share of voice against a peer set.
      Requires the `can_use_tone` / `can_use_share_of_voice` entitlement; social
      signal is an admin-only preview.
  - name: Facilities
    description: >-
      Unified physical-asset directory — GEM energy assets, World Port Index
      ports and Epoch AI data centers on one keyed surface, resolved to spine
      owners. Requires the `can_use_facilities` entitlement.
  - name: Monitors
    description: >-
      Organization-shared scheduled checks over the Core API, with email and
      signed-webhook delivery. Monitor execution does not consume query units.
  - name: Geography
    description: >-
      Country context and admin-1 geography: /api/v2/countries (publication
      activity, reporting counts, dated economic and resource fundamentals,
      facility and office inventories, directory mode over every registered
      country) and admin-1 lookups.
  - name: Government
    description: >-
      US federal awards (USAspending) and foreign-influence registrations (DOJ
      NSD FARA), resolved onto the entity spine. Requires the `can_use_gov`
      entitlement.
  - name: Political Offices
    description: >-
      Public political offices and who holds them — legislatures, cabinets,
      heads of state, courts and IGO posts, with the office start/end dates the
      publisher states (valid time), resolved onto the entity spine. Actor
      context for geopolitical analysis; NOT a PEP or sanctions-screening tool.
      Requires the `can_use_offices` entitlement.
  - name: Filings
    description: >-
      SEC EDGAR filings, XBRL financials, and relations extracted from filing
      text. Requires the `can_use_filings` entitlement.
  - name: Reference Data
    description: >-
      The GLEIF Global LEI Index — legal-entity reference data, consolidation
      relationships, and LEI↔ISIN mappings. Requires the `can_use_gleif`
      entitlement.
  - name: Energy
    description: Global Energy Monitor assets + ownership registry.
  - name: AI Compute
    description: >-
      Epoch AI datasets — models, hardware, data centers, companies and chip
      sales. Requires the `can_use_epoch_ai` entitlement.
  - name: Macro Finance
    description: >-
      FRED economic time series — catalog, point-in-time observations and
      releases. Requires the `can_use_macro` entitlement.
  - name: Screening and Reference
    description: >-
      Restricted-party lists, name screening and ownership-chain exposure.
      Requires the `can_use_screening` / `can_use_exposure` entitlement.
      Analytical coverage, not an audit-grade compliance control.
  - name: China
    description: >-
      China overseas development finance (AidData GCDF). Requires the
      `can_use_china` entitlement.
  - name: Maritime
    description: >-
      AIS-derived vessel flow — chokepoint transits, last-known vessel
      positions, carriers, dwell and AIS-dark gaps. Terrestrial AIS only, so
      coverage thins in open ocean. Requires the `can_use_maritime` entitlement.
  - name: Atlas Intelligence
    description: >-
      Geopolitical-risk and posture indices computed from GDELT Cloud’s own
      coded events, normalized to each place’s own frozen baseline.
  - name: Natural Resources
    description: >-
      USGS mineral production, reserves and qualified country statistics,
      composed with the physical Facilities inventory.
  - name: Briefs
    description: Source-backed monitoring briefs.
  - name: Meta
    description: >-
      Machine-readable discovery: the value vocabularies, the endpoint
      contracts, and the query-unit cost model. Unmetered, so a client can check
      before it spends.
paths:
  /api/v2/epoch/models:
    get:
      tags:
        - AI Compute
      summary: AI models
      description: >-
        Epoch model observations with terminal entity IDs, separately resolved
        participants, source roles and publication coverage.
      operationId: get-epoch-models-v2
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 25
          description: >-
            Rows per page. Default 25, max 200. Note: validation is owned by the
            endpoint service because it depends on composed or cross-parameter
            state; the published error semantics above still apply.
          example: '25'
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Opaque pagination cursor taken from the previous response's
            `pagination.next_cursor`. Also accepts: `offset`. Note: validation
            is owned by the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply.
          example: '25'
          x-aliases:
            - offset
        - name: entity
          in: query
          required: false
          schema:
            type: string
          description: >-
            Participant entity: spine ID, news ID, Wikipedia URL or resolved
            name; all terminal aliases are included. Note: validation is owned
            by the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply. Full value list:
            https://docs.gdeltcloud.com/reference/enums#entity_handle
          example: Microsoft
        - name: participant_role
          in: query
          required: false
          schema:
            type: string
          description: >-
            Exact source role. Hardware ownership does not establish building
            ownership. Note: validation is owned by the endpoint service because
            it depends on composed or cross-parameter state; the published error
            semantics above still apply.
          example: owner
        - name: organization
          in: query
          required: false
          schema:
            type: string
          description: >-
            Developer substring. Also accepts: `org`. Note: validation is owned
            by the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply.
          example: OpenAI
          x-aliases:
            - org
        - name: domain
          in: query
          required: false
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - Language
                - Vision
                - Biology
                - Multimodal
                - Image generation
                - Video
                - Speech
                - Robotics
                - Games
                - Audio
                - Medicine
                - Mathematics
                - Materials science
                - Earth science
                - Recommendation
                - Driving
                - Search
                - 3D modeling
                - Other
                - Psychology
                - Astronomy
                - Cybersecurity
          description: >-
            One domain or a comma-separated intersection of task domains. Note:
            validation is owned by the endpoint service because it depends on
            composed or cross-parameter state; the published error semantics
            above still apply. Full value list:
            https://docs.gdeltcloud.com/reference/enums#epoch_model_domain
          example: Language
        - name: model_accessibility
          in: query
          required: false
          schema:
            type: string
            enum:
              - Open weights (unrestricted)
              - Open weights (restricted use)
              - Open weights (non-commercial)
              - API access
              - Hosted access (no API)
              - Limited access
              - Unreleased
          description: >-
            Exact accessibility tier, case-insensitive. Note: validation is
            owned by the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply. Full value list:
            https://docs.gdeltcloud.com/reference/enums#epoch_model_accessibility
          example: Limited access
        - name: organization_categorization
          in: query
          required: false
          schema:
            type: string
          description: >-
            Source organization-category substring. Note: validation is owned by
            the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply.
          example: Academia
        - name: frontier
          in: query
          required: false
          schema:
            type: boolean
          description: >-
            true/false selects frontier/non-frontier models. Note: validation is
            owned by the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply.
          example: 'true'
        - name: min_compute
          in: query
          required: false
          schema:
            type: number
            minimum: 0
          description: >-
            Positive floor on source training FLOP. Note: validation is owned by
            the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply.
          example: '1e25'
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            publication_date or compute. Note: validation is owned by the
            endpoint service because it depends on composed or cross-parameter
            state; the published error semantics above still apply.
          example: compute
        - name: date_start
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            Inclusive source-date lower bound, YYYY-MM-DD. Note: validation is
            owned by the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply.
          example: '2025-01-01'
        - name: date_end
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            Inclusive source-date upper bound, YYYY-MM-DD. Note: validation is
            owned by the endpoint service because it depends on composed or
            cross-parameter state; the published error semantics above still
            apply.
          example: '2026-09-30'
      responses:
        '200':
          description: >-
            A page of AI models. Envelope: `{ success, data, pagination,
            applied_filters }`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        model:
                          type: string
                        domain:
                          type: string
                        organization:
                          type: string
                        publication_date:
                          type: string
                        parameters:
                          type: number
                          nullable: true
                        training_compute_flop:
                          type: number
                          nullable: true
                        training_hardware:
                          type: string
                          nullable: true
                        frontier_model:
                          type: boolean
                          nullable: true
                        open_weights:
                          type: boolean
                          nullable: true
                        model_accessibility:
                          type: string
                          nullable: true
                        entity_id:
                          type: string
                          description: Spine entity id for the developing organization.
                        entity_page_name:
                          type: string
                          description: >-
                            Wiki-backed name that resolves to the entity's
                            `/entities` page, or empty string when it has no
                            wiki twin.
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      offset:
                        type: integer
                      next_cursor:
                        type: string
                        nullable: true
                        description: >-
                          Canonical page token — pass it back as `cursor` to
                          fetch the next page (uniform across all list
                          endpoints). `null` when there are no more rows.
                      next_offset:
                        type: integer
                        nullable: true
                        deprecated: true
                        description: >-
                          Legacy — prefer `next_cursor` (still returned).
                          Numeric row offset of the next page.
                  applied_filters:
                    type: object
                    properties:
                      organization:
                        type: string
                      frontier:
                        type: boolean
                      sort:
                        type: string
                      ignored:
                        type: object
              examples:
                example:
                  summary: >-
                    GET /api/v2/epoch/models?frontier=true&sort=compute —
                    example response
                  value:
                    success: true
                    data:
                      - model: GPT-4
                        domain: Language
                        organization: OpenAI
                        publication_date: '2023-03-14'
                        parameters: null
                        training_compute_flop: 2.1e+25
                        training_hardware: NVIDIA A100 SXM4 80 GB
                        frontier_model: true
                        open_weights: false
                        model_accessibility: API access
                        entity_id: e_58a5cada3c775725
                        entity_page_name: OpenAI
                    pagination:
                      limit: 25
                      offset: 0
                      next_cursor: null
                      next_offset: null
                    applied_filters:
                      frontier: true
                      sort: compute
                      ignored: {}
        '401':
          description: Missing/invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Plan required (PLAN_REQUIRED) — the caller's plan does not carry the
            required source entitlement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: string
        code:
          type: string
        details:
          type: object
          description: >-
            Recoverable validation context when available, such as param,
            invalid_value, accepted_values, nearest_values, and a corrected
            example.
          additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: gdelt_sk_...
      description: 'GDELT Cloud API key. Send as `Authorization: Bearer gdelt_sk_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.