> ## 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. # Trigger a tone run > Queue an on-demand entity-tone scoring run for an entity/topic. Requires a plan with Entity media tone access (`can_use_tone`) — the Analyst, Media Intelligence, Geopolitical Intelligence, and Global Intelligence plans. ## OpenAPI ````yaml /api-reference/openapi-v2.json post /api/v2/entity-tone/runs 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/entity-tone/runs: post: tags: - Media Intelligence summary: Trigger a tone run description: >- Queue an on-demand entity-tone scoring run for an entity/topic. Requires a plan with Entity media tone access (`can_use_tone`) — the Analyst, Media Intelligence, Geopolitical Intelligence, and Global Intelligence plans. operationId: create-entity-tone-run-v2 parameters: - name: entity_search in: query required: false schema: type: string description: Entity to score. - name: topic in: query required: false schema: type: string description: Optional topic anchor. responses: '200': description: Trigger a tone run. content: application/json: schema: type: object properties: success: type: boolean data: type: object properties: run_id: type: string status: type: string poll_url: type: string confirm_required: type: boolean entity_ids: type: array items: type: string resolved_entities: type: array items: type: object properties: canonical_entity_id: type: string display_name: type: string entity_type: type: string wikipedia_url: type: string match_type: type: string confidence: type: number window: type: object properties: start_date: type: string end_date: type: string candidate_story_count: type: integer candidate_article_count: type: integer queued_case_count: type: integer estimated_query_units: type: integer charged_query_units: type: integer estimated_cost_usd: type: number note: type: string examples: example: summary: POST /api/v2/entity-tone/runs — example response value: success: true data: run_id: entity-tone-v2-3f9c1b2a-7d4e-4a51-9c83-1e6b2f0a55d1 status: queued poll_url: >- /api/v2/entity-tone/runs/entity-tone-v2-3f9c1b2a-7d4e-4a51-9c83-1e6b2f0a55d1 confirm_required: false entity_ids: - wikipedia:en:Saudi_Aramco resolved_entities: - canonical_entity_id: wikipedia:en:Saudi_Aramco display_name: Saudi Aramco entity_type: organization wikipedia_url: https://en.wikipedia.org/wiki/Saudi_Aramco match_type: exact_alias confidence: 0.98 window: start_date: '2026-06-01' end_date: '2026-06-28' candidate_story_count: 213 candidate_article_count: 1486 queued_case_count: 188 estimated_query_units: 23 charged_query_units: 0 estimated_cost_usd: 0.1704 note: >- Run queued in the V2 entity-tone side pipeline. Scoring is asynchronous and cached rows become available through /api/v2/entity-tone. '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_...`.' ````