CLEARIE™ GETWAYEX-IM Intelligence & APIs
← Marketplace

Intelligence · min plan: starter · ai (20u) · scope: write:ai · both

AI Trade Impact Analyze

Returns the same grounded decision payload used by the AI Trade Impact workspace, including checks, risks, opportunities, actions, evidence resolution, citations, and source links. A successful live call uses 20 API units plus depth credits: basic 5, advanced 10, deep 50, or dedicated 50. AI credits are waived when no chargeable AI output is delivered.

POST /v1/ai/impact-analyze

Required scope

write:ai

Weighted API units

20 per success

Minimum plan

starter

Rate-limit bucket

ai

AI credits

basic 5 · advanced 10 · deep 50 · dedicated 50

Parameters

NameInTypeRequiredDescription
querybodystringyesNatural-language trade question.
entitybodystring—Optional entity or customer.
depthbodystring—basic, advanced, deep, or dedicated.

Sample request

curl -X POST "https://getway.clearie.ai/v1/ai/impact-analyze" -H "Authorization: Bearer $CLEARIE_API_KEY" -H "Content-Type: application/json" -d '{"query":"Red Sea routing impact","depth":"basic"}'

Sample response

{
  "id": "an_01JTRADEIMPACT",
  "query": "How could Red Sea disruption affect our India electronics imports?",
  "entity": "Electronics import portfolio",
  "generated_at": "2026-09-12T10:30:00Z",
  "exposure_level": "elevated",
  "active_events": 3,
  "top_regions": [
    "Red Sea",
    "India",
    "Southeast Asia"
  ],
  "recent_context": "Verified route disruption and India import context indicate longer transit times and landed-cost pressure.",
  "context_citations": [
    "src_event_01",
    "src_cbic_01"
  ],
  "risk_factors": [
    {
      "id": "risk_01",
      "title": "Transit delay",
      "description": "Rerouting can extend lead time.",
      "severity": "elevated",
      "confidence": "high",
      "timeline": "0-30d",
      "drivers": [
        "Carrier rerouting"
      ],
      "citations": [
        "src_event_01"
      ]
    }
  ],
  "opportunities": [
    {
      "id": "opp_01",
      "title": "Alternate origin review",
      "description": "Compare qualified suppliers on unaffected lanes.",
      "timeline": "30-90d",
      "confidence": "medium",
      "citations": [
        "src_event_01"
      ]
    }
  ],
  "recommendations": [
    {
      "id": "rec_01",
      "title": "Reprice open purchase orders",
      "detail": "Refresh freight and buffer assumptions before confirmation.",
      "tier": "immediate",
      "owner": "Trade operations",
      "citations": [
        "src_event_01"
      ]
    }
  ],
  "resilience_score": 6.4,
  "resilience_confidence": "medium",
  "exposure": {
    "customers": [
      {
        "name": "Portfolio",
        "share": 1,
        "trend": "flat",
        "note": "Portfolio-level request"
      }
    ],
    "lanes": [
      {
        "name": "Asia to India",
        "share": 0.7,
        "trend": "up",
        "note": "Red Sea routing exposure"
      }
    ],
    "products": [
      {
        "name": "Electronics",
        "share": 0.6,
        "trend": "up",
        "note": "Freight-sensitive imports"
      }
    ]
  },
  "sectors": [
    {
      "sector": "Electronics",
      "intensity": 0.72,
      "direction": "headwind"
    }
  ],
  "analysis_checks": [
    {
      "id": "recent_trade_events",
      "label": "Recent trade events",
      "status": "completed",
      "summary": "3 relevant events validated"
    }
  ],
  "markdown": "## Decision brief\\nReprice affected purchase orders and compare alternate lanes.",
  "citations": [
    "src_event_01",
    "src_cbic_01"
  ],
  "source_references": [
    {
      "id": "src_event_01",
      "title": "Verified disruption notice",
      "url": "https://www.cbic.gov.in/",
      "publisher": "Official authority",
      "source_type": "official",
      "published_at": "2026-09-10T08:00:00Z",
      "confidence": "high",
      "freshness": "current",
      "age_days": 2
    }
  ],
  "evidence_resolution": {
    "search_mode": "getway_only",
    "internal_source_count": 2,
    "live_source_count": 0,
    "official_source_count": 1,
    "institutional_source_count": 1,
    "secondary_source_count": 0,
    "unknown_source_count": 0,
    "current_source_count": 2,
    "stale_source_count": 0,
    "unknown_freshness_count": 0,
    "sufficiency_score": 0.86,
    "minimum_score": 0.4,
    "target_score": 0.7,
    "search_performed": false,
    "search_queries": [],
    "searched_at": null,
    "coverage_gaps": [],
    "source_tier_counts": {
      "official": 1,
      "institutional": 1
    },
    "chargeable": true,
    "no_charge_reason": null,
    "summary": "Grounded with current internal evidence."
  },
  "usage": {
    "environment": "live",
    "weighted_api_units": 20,
    "api_units_charged": 20,
    "sandbox_calls_charged": 0,
    "ai_credits_scheduled": 5,
    "ai_credits_charged": 5,
    "depth": "basic",
    "status": "charged",
    "no_charge_reason": null
  }
}

Live response contract

Live calls require API-key authentication, write:ai scope, plan access, and available quota. Successful calls consume 20 weighted API units plus the selected depth's AI credits; failed responses release reservations. AI credits are waived when no chargeable AI output is delivered.

Sandbox sample response

Workspace try-it calls use isolated representative sandbox records. They are for integration validation, not production filing.

Error examples

401 invalid key · 403 missing scope or plan · 429 quota/rate limit · 404 no verified data where applicable.

Response schema

root object {
id* string// e.g. "an_01JTRADEIMPACT"
query* string// e.g. "How could Red Sea disruption affect our India electronics imports?"
entity* string// e.g. "Electronics import portfolio"
generated_at* string// e.g. "2026-09-12T10:30:00Z"
exposure_level* string// e.g. "elevated"
active_events* integer// e.g. 3
top_regions* array [
item string// e.g. "Red Sea"
]
recent_context* string// e.g. "Verified route disruption and India import context indicate longer transit times and landed-cost pressure."
context_citations* array [
item string// e.g. "src_event_01"
]
risk_factors* array [
item object {
id* string// e.g. "risk_01"
title* string// e.g. "Transit delay"
description* string// e.g. "Rerouting can extend lead time."
severity* string// e.g. "elevated"
confidence* string// e.g. "high"
timeline* string// e.g. "0-30d"
drivers* array [
item string// e.g. "Carrier rerouting"
]
citations* array [
item string// e.g. "src_event_01"
]
}
]
opportunities* array [
item object {
id* string// e.g. "opp_01"
title* string// e.g. "Alternate origin review"
description* string// e.g. "Compare qualified suppliers on unaffected lanes."
timeline* string// e.g. "30-90d"
confidence* string// e.g. "medium"
citations* array [
item string// e.g. "src_event_01"
]
}
]
recommendations* array [
item object {
id* string// e.g. "rec_01"
title* string// e.g. "Reprice open purchase orders"
detail* string// e.g. "Refresh freight and buffer assumptions before confirmation."
tier* string// e.g. "immediate"
owner* string// e.g. "Trade operations"
citations* array [
item string// e.g. "src_event_01"
]
}
]
resilience_score* number// e.g. 6.4
resilience_confidence* string// e.g. "medium"
exposure* object {
customers* array [
item object {
name* string// e.g. "Portfolio"
share* integer// e.g. 1
trend* string// e.g. "flat"
note* string// e.g. "Portfolio-level request"
}
]
lanes* array [
item object {
name* string// e.g. "Asia to India"
share* number// e.g. 0.7
trend* string// e.g. "up"
note* string// e.g. "Red Sea routing exposure"
}
]
products* array [
item object {
name* string// e.g. "Electronics"
share* number// e.g. 0.6
trend* string// e.g. "up"
note* string// e.g. "Freight-sensitive imports"
}
]
}
sectors* array [
item object {
sector* string// e.g. "Electronics"
intensity* number// e.g. 0.72
direction* string// e.g. "headwind"
}
]
analysis_checks* array [
item object {
id* string// e.g. "recent_trade_events"
label* string// e.g. "Recent trade events"
status* string// e.g. "completed"
summary* string// e.g. "3 relevant events validated"
}
]
markdown* string// e.g. "## Decision brief\\nReprice affected purchase orders and compare alternate lanes."
citations* array [
item string// e.g. "src_event_01"
]
source_references* array [
item object {
id* string// e.g. "src_event_01"
title* string// e.g. "Verified disruption notice"
url* string// e.g. "https://www.cbic.gov.in/"
publisher* string// e.g. "Official authority"
source_type* string// e.g. "official"
published_at* string// e.g. "2026-09-10T08:00:00Z"
confidence* string// e.g. "high"
freshness* string// e.g. "current"
age_days* integer// e.g. 2
}
]
evidence_resolution* object {
search_mode* string// e.g. "getway_only"
internal_source_count* integer// e.g. 2
live_source_count* integer// e.g. 0
official_source_count* integer// e.g. 1
institutional_source_count* integer// e.g. 1
secondary_source_count* integer// e.g. 0
unknown_source_count* integer// e.g. 0
current_source_count* integer// e.g. 2
stale_source_count* integer// e.g. 0
unknown_freshness_count* integer// e.g. 0
sufficiency_score* number// e.g. 0.86
minimum_score* number// e.g. 0.4
target_score* number// e.g. 0.7
search_performed* boolean// e.g. false
search_queries* array [
item string
]
searched_at* null
coverage_gaps* array [
item string
]
source_tier_counts* object {
official* integer// e.g. 1
institutional* integer// e.g. 1
}
chargeable* boolean// e.g. true
no_charge_reason* null
summary* string// e.g. "Grounded with current internal evidence."
}
usage* object {
environment* string// e.g. "live"
weighted_api_units* integer// e.g. 20
api_units_charged* integer// e.g. 20
sandbox_calls_charged* integer// e.g. 0
ai_credits_scheduled* integer// e.g. 5
ai_credits_charged* integer// e.g. 5
depth* string// e.g. "basic"
status* string// e.g. "charged"
no_charge_reason* null
}
}

Try this API live in the workspace

The in-app try-it console runs against the isolated deterministic sandbox repository. It never reads live customer or reference records.