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

AI Trade Impact Analyze

Analyzes a trade question using verified reference, regulatory, event, and sanctions context. Depth also consumes AI credits.

POST /v1/ai/impact-analyze

Required scope

write:ai

API credits

20 per success

Minimum plan

starter

Rate-limit bucket

Parameters

Name	In	Type	Required	Description
query	body	string	yes	Natural-language trade question.
entity	body	string	—	Optional entity or customer.
depth	body	string	—	basic, advanced, deep, or dedicated.

Sample request

curl -X POST "https://getway.clearie.neximprove.com/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": "analysis_id",
  "exposure_level": "elevated",
  "resilience_score": 6.4,
  "citations": [
    "source-id"
  ],
  "meta": {
    "weighted_units": 20,
    "ai_credits": 5
  }
}

Live response contract

Live calls require API-key authentication, write:ai scope, plan access, and available quota. Successful calls consume 20 API credits.

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. "analysis_id"

exposure_level* string// e.g. "elevated"

resilience_score* number// e.g. 6.4

citations* array [

item string// e.g. "source-id"

]

meta* object {

weighted_units* integer// e.g. 20

ai_credits* integer// e.g. 5

}

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.

Open in workspace Create account