{"openapi":"3.1.0","info":{"title":"Semantic Visions - One API","description":"\nSemantic Visions turns global news into risk signals about companies, commodities, industries and\nlocations. You start with a list of names and get back a news-based risk picture for each one: a health\nscore and sanctions flag, plain-language summaries of what has happened, and a timeline of individual\nevents such as lawsuits, strikes, cyberattacks or supply disruptions. Everything comes from news in\n12 languages, is updated hourly, and is returned as JSON you can load straight into your own dashboard,\nscreening process or model.\n\n## API Structure\n\nThe API is split into two main parts:\n\n### 1. Watchlists API\n\nThe Watchlists API is used to manage monitoring watchlists, submit screenings and retrieve results from those.\n\n* **🗂️ Projects**: The watchlists your account can access and how they are configured.\n* **📤 Requests**: Submit entities for hourly **monitoring** or a one-time **screening**, and track validation.\n* **📥 Results**: Download the scenarios found for your entities and the articles behind them.\n\n### 2. SVEye Public API (Insights, Entities, Search)\n\nThe SVEye Public API gives programmatic access to SvEye Application data.\n\n* **🔍 Search**: Query Events and Summaries with advanced filtering and pagination.\n* **📊 Entities**: Industries, commodities, locations, legal entities, and companies/brands\n* **📚 Enumerations**: Entity types, impact types, event categories, event types, and languages\n\nSuggested usage:\n1. Retrieve entities that you want to monitor in **Entities**.\n2. Retrieve categorization / languages that interest you in **Enumerations**.\n3. Search for Events and Summaries in **Search**.\n\n## Key Concepts\n\nEvery search works on entity IDs, so names must be resolved to IDs first.\n\n| Object | What it is |\n| --- | --- |\n| Entity | Something we track: company (brand, `_BR_…`), legal entity (`_CO_…`), commodity, industry or location. |\n| Event | One signal: entity + event type + time, clustered from articles, with an `intensity` (1–1000). |\n| Summary | A narrative of a real-world development over a period, grouping several events, with a sentiment (−2 to 2). |\n| Taxonomy | Impact type › event category › event type, used as search filters. It differs per entity type. |\n| Company details | Health score (−100 to 100, six sub-scores), event counts and sanctions flag. |\n| Scenario | Watchlists: one of your entities + one event type at a point in time, with its supporting articles. |\n\nRule of thumb: use **summaries** for human-readable briefings and **events** for timelines, counts and\nquantitative signals. Brands (`_BR_`) are public names; legal entities (`_CO_`) are registered companies\nwith a legal form. Sentiment describes the development itself (a flood is negative), not how it affects you.\n\nFor step-by-step workflows with example calls, see **Use Cases**.\n\n## Credits and Rate Limits\n\nInsights calls are billed in credits from your monthly allowance; Watchlists are contract-based.\n\n| Call | Credit cost |\n| --- | --- |\n| `POST /token` | Free |\n| `GET /entities/v1/companies`, `GET /entities/v1/legal_entities` | 10 per row returned |\n| `GET /entities/v1/commodities`, `/industries`, `/locations` | Free |\n| `GET /entities/v1/companies/details` | 100 per company returned |\n| `GET /insights/v1/event_types_tree` and other enumerations | Free |\n| `POST /insights/v1/search_summary` | 5 per summary returned |\n| `POST /insights/v1/search_event` | 1 per event returned |\n| `GET /insights/v1/supply_chain` | 100 per relation returned |\n| `/watchlists/v1/…` | Contract-based |\n\nRate limits: `POST /token` allows 12 requests per minute; Entities, Insights and Watchlists reads allow\n120 per minute; watchlist submissions and deletions allow 30 per minute. Above a limit, or when your\nmonthly credits are used up, the API returns HTTP 429; wait and retry.\n\nTips:\n\n* **Resolve once, reuse.** ID lookups cost credits, so store the name → ID mapping in your own system.\n* **Always set a date range and count.** `date_from` and `date_to` are required. Start with `count`\n  25–100; the API accepts up to 10,000, which uses credits fast.\n* **Cursor paging:** send back the cursor unchanged, with the same `sort_by`.\n* **Strict request bodies:** search bodies reject unknown fields, so a typo returns a 422 error instead of\n  being ignored.\n* **Timestamps:** Insights returns epoch milliseconds (summaries also carry `*_time_string` fields);\n  Watchlists use ISO 8601.\n\n## Authentication\n\nAll endpoints require JWT token authentication. To retrieve a JWT token, you can use the following endpoint:\n```\ncurl --location 'https://api.semantic-visions.com/token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'username=XXX' \\\n--data-urlencode 'password=YYY' \\\n--data-urlencode 'grant_type=password'\n```\n\nSend the returned `access_token` in the `Authorization: Bearer YOUR_ACCESS_TOKEN` header of every request.\nTokens expire: when a call returns HTTP 401, request a new token. Reuse one token for many calls instead\nof requesting a new one each time.\n\nTo try calls in these docs, sign in with your username and password in the Authentication panel, or paste\na token you already have.\n\n### Getting Credentials\n\n**SvEye**: If you are coming from SvEye (<https://sveye.semantic-visions.com>), you can generate the credentials from Account→API.\n\n**Watchlists**: For using the Watchlists API, please contact our sales at\n[sales@semantic-visions.com](mailto:sales@semantic-visions.com) for onboarding.\n\n## Support\n\nFor questions about this API, contact [support@semantic-visions.com](mailto:support@semantic-visions.com),\nMonday to Friday, 9:00–17:00 Central European Time.\n","version":"1.0.0"},"paths":{"/watchlists/v1/monitoring/results/scenarios/{watchlist_id}/{batch_time}":{"get":{"tags":["Watchlists - Results"],"summary":"Get Monitoring Batch","operationId":"get_monitoring_batch_watchlists_v1_monitoring_results_scenarios__watchlist_id___batch_time__get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"watchlist_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the Monitoring watchlist to retrieve results for","title":"Watchlist Id"},"description":"The ID of the Monitoring watchlist to retrieve results for"},{"name":"batch_time","in":"path","required":true,"schema":{"type":"string","description":"The batch time to retrieve results for","title":"Batch Time"},"description":"The batch time to retrieve results for"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of scenarios to return","default":100,"title":"Limit"},"description":"Maximum number of scenarios to return"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of scenarios to skip","default":0,"title":"Offset"},"description":"Number of scenarios to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ScenarioResult_"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/screening/results/scenarios/{screening_id}":{"get":{"tags":["Watchlists - Results"],"summary":"Get Screening Results","operationId":"get_screening_results_watchlists_v1_screening_results_scenarios__screening_id__get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"screening_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the Screening request to retrieve results for","title":"Screening Id"},"description":"The ID of the Screening request to retrieve results for"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of scenarios to return","default":100,"title":"Limit"},"description":"Maximum number of scenarios to return"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of scenarios to skip","default":0,"title":"Offset"},"description":"Number of scenarios to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ScenarioResult_"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/monitoring/results/articles/{watchlist_id}/{batch_time}":{"get":{"tags":["Watchlists - Results"],"summary":"Get Monitoring Articles","operationId":"get_monitoring_articles_watchlists_v1_monitoring_results_articles__watchlist_id___batch_time__get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"watchlist_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the Monitoring watchlist to retrieve articles for","title":"Watchlist Id"},"description":"The ID of the Monitoring watchlist to retrieve articles for"},{"name":"batch_time","in":"path","required":true,"schema":{"type":"string","description":"The batch time to retrieve articles for","title":"Batch Time"},"description":"The batch time to retrieve articles for"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of articles to return","default":100,"title":"Limit"},"description":"Maximum number of articles to return"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of articles to skip","default":0,"title":"Offset"},"description":"Number of articles to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ArticleResult_"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/screening/results/articles/{screening_id}":{"get":{"tags":["Watchlists - Results"],"summary":"Get Screening Articles","operationId":"get_screening_articles_watchlists_v1_screening_results_articles__screening_id__get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"screening_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the Screening request to retrieve articles for","title":"Screening Id"},"description":"The ID of the Screening request to retrieve articles for"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of articles to return","default":100,"title":"Limit"},"description":"Maximum number of articles to return"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of articles to skip","default":0,"title":"Offset"},"description":"Number of articles to skip"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ArticleResult_"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/screening/results_status/{screening_id}":{"get":{"tags":["Watchlists - Results"],"summary":"Get Screening Results Status","operationId":"get_screening_results_status_watchlists_v1_screening_results_status__screening_id__get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"screening_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the Screening request to retrieve results status for","title":"Screening Id"},"description":"The ID of the Screening request to retrieve results status for"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreeningResultStatus"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/monitoring/results_status/{watchlist_id}/{batch_time}":{"get":{"tags":["Watchlists - Results"],"summary":"Get Monitoring Results Status","operationId":"get_monitoring_results_status_watchlists_v1_monitoring_results_status__watchlist_id___batch_time__get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"watchlist_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the Monitoring watchlist to retrieve results status for","title":"Watchlist Id"},"description":"The ID of the Monitoring watchlist to retrieve results status for"},{"name":"batch_time","in":"path","required":true,"schema":{"type":"string","description":"The batch time to retrieve results status for","title":"Batch Time"},"description":"The batch time to retrieve results status for"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringResultStatus"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/project_configuration":{"get":{"tags":["Watchlists - Projects"],"summary":"Get configurations for projects that the user has access to","operationId":"get_project_configuration_watchlists_v1_project_configuration_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectConfigurationResponse"},"type":"array","title":"Response Get Project Configuration Watchlists V1 Project Configuration Get"}}}}},"security":[{"HTTPBearer":[]},{"OAuth2Password":[]}]}},"/watchlists/v1/screening/{watchlist_id}":{"post":{"tags":["Watchlists - Requests"],"summary":"Submit Screening Watchlist","operationId":"submit_screening_watchlist_watchlists_v1_screening__watchlist_id__post","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"watchlist_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the watchlist","title":"Watchlist Id"},"description":"The ID of the watchlist"},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Start date for screening in ISO format (YYYY-MM-DD)","title":"Start Date"},"description":"Start date for screening in ISO format (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"End date for screening in ISO format (YYYY-MM-DD)","title":"End Date"},"description":"End date for screening in ISO format (YYYY-MM-DD)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WatchlistEntity-Input"},"title":"Entities"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreeningRequestResponse"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/screening/watchlist_status/{screening_id}":{"get":{"tags":["Watchlists - Requests"],"summary":"Get Screening Status","operationId":"get_screening_status_watchlists_v1_screening_watchlist_status__screening_id__get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"screening_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the screening request","title":"Screening Id"},"description":"The ID of the screening request"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreeningStatusResponse"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/monitoring/{watchlist_id}":{"post":{"tags":["Watchlists - Requests"],"summary":"Submit Monitoring Watchlist","operationId":"submit_monitoring_watchlist_watchlists_v1_monitoring__watchlist_id__post","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"watchlist_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the watchlist","title":"Watchlist Id"},"description":"The ID of the watchlist"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WatchlistEntity-Input"},"title":"Entities"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringRequestResponse"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/monitoring/{watchlist_id}/entities":{"delete":{"tags":["Watchlists - Requests"],"summary":"Delete Monitoring Entities","operationId":"delete_monitoring_entities_watchlists_v1_monitoring__watchlist_id__entities_delete","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"watchlist_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the watchlist","title":"Watchlist Id"},"description":"The ID of the watchlist"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMonitoringEntitiesRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringRequestResponse"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Watchlists - Requests"],"summary":"Get current entities in a monitoring watchlist","operationId":"get_monitoring_entities_watchlists_v1_monitoring__watchlist_id__entities_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"watchlist_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the watchlist","title":"Watchlist Id"},"description":"The ID of the watchlist"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WatchlistEntity-Output"},"title":"Response Get Monitoring Entities Watchlists V1 Monitoring  Watchlist Id  Entities Get"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/watchlists/v1/monitoring/request_status/{monitoring_request_id}":{"get":{"tags":["Watchlists - Requests"],"summary":"Get Monitoring Status","operationId":"get_monitoring_status_watchlists_v1_monitoring_request_status__monitoring_request_id__get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"monitoring_request_id","in":"path","required":true,"schema":{"type":"string","description":"The ID of the monitoring request","title":"Monitoring Request Id"},"description":"The ID of the monitoring request"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringStatusResponse"}}}},"403":{"description":"The authenticated user is not authorized to access this watchlist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/insights/v1/entity_types":{"get":{"tags":["Insights - Enumerations"],"summary":"Get all available entity types","description":"Returns a list of all available entity types.","operationId":"entity_types_insights_v1_entity_types_get","responses":{"200":{"description":"Success response with list of available entity types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityTypesResponse"},"example":{"entity_types":["legal_entity","industry"]}}}}},"security":[{"HTTPBearer":[]},{"OAuth2Password":[]}]}},"/insights/v1/impact_types":{"get":{"tags":["Insights - Enumerations"],"summary":"Get all available impact types for a specific entity type","description":"Returns a list of all available impact types.","operationId":"impact_types_insights_v1_impact_types_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"entity_type","in":"query","required":true,"schema":{"enum":["commodity","company","industry","legal_entity","location"],"type":"string","description":"Type of entity to get.","title":"Entity Type"},"description":"Type of entity to get."}],"responses":{"200":{"description":"Success response with list of available impact types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpactTypesResponse"},"example":{"impact_types":["SVEYE_BUSINESS_RISK_IT","SVEYE_OPERATIONAL_RISK_IT","SVEYE_FINANCIAL_RISK_IT","SVEYE_REPUTATIONAL_RISK_IT"],"count":4}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/insights/v1/event_categories":{"get":{"tags":["Insights - Enumerations"],"summary":"Get all available event categories for a specific entity type","description":"Returns a list of all available event categories for a specific entity type.","operationId":"event_categories_insights_v1_event_categories_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"entity_type","in":"query","required":true,"schema":{"enum":["commodity","company","industry","legal_entity","location"],"type":"string","description":"Type of entity to get.","title":"Entity Type"},"description":"Type of entity to get."},{"name":"impact_types","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Impact types to filter by","title":"Impact Types"},"description":"Impact types to filter by"}],"responses":{"200":{"description":"Success response with list of available event categories","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCategoriesResponse"},"example":{"event_categories":["SVEYE_REGULATORY_COMPLIANCE_ISSUES_EC","SVEYE_OPERATIONAL_RISK_EC","SVEYE_BUSINESS_CHANGE_EC","SVEYE_FINANCIAL_RISK_EC"],"count":4}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/insights/v1/event_types":{"get":{"tags":["Insights - Enumerations"],"summary":"Get all available event types for a specific entity type","description":"Returns a list of all available event types (lowest level items ending with _ET) for a specific entity type.","operationId":"event_types_insights_v1_event_types_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"entity_type","in":"query","required":true,"schema":{"enum":["commodity","company","industry","legal_entity","location"],"type":"string","description":"Type of entity to get.","title":"Entity Type"},"description":"Type of entity to get."},{"name":"impact_types","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Impact types to filter by","title":"Impact Types"},"description":"Impact types to filter by"},{"name":"event_categories","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Event categories to filter by","title":"Event Categories"},"description":"Event categories to filter by"}],"responses":{"200":{"description":"Success response with list of available event types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTypesListResponse"},"example":{"event_types":["SVEYE_PRODUCT_AND_OPERATIONAL_COMPLIANCE_RISK_ET","SVEYE_TRADING_RISK_ET","SVEYE_REGULATORY_COMPLIANCE_RISK_ET","SVEYE_OPERATIONAL_RISK_ET"],"count":4}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/insights/v1/event_types_for_entity_type":{"get":{"tags":["Insights - Enumerations"],"summary":"Get event types for a given entity type","description":"Returns a list of all available event types (lowest level items ending with _ET) for a specific entity type.","operationId":"event_types_for_entity_type_insights_v1_event_types_for_entity_type_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"entity_type","in":"query","required":true,"schema":{"enum":["commodity","company","industry","legal_entity","location"],"type":"string","description":"Type of entity to get.","title":"Entity Type"},"description":"Type of entity to get."}],"responses":{"200":{"description":"Success response with list of available event types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllEventTypesListResponse"},"example":{"count":2,"event_types":["SVEYE_ENVIRONMENTAL_CONTRA_ET","SVEYE_SPINOFFS_ET"]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/insights/v1/event_types_tree":{"get":{"tags":["Insights - Enumerations"],"summary":"Get event types tree structure: Impact Types -> Event Categories -> Event Types","description":"Returns a hierarchical tree structure of event types","operationId":"event_types_tree_insights_v1_event_types_tree_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"entity_type","in":"query","required":true,"schema":{"enum":["commodity","company","industry","legal_entity","location"],"type":"string","description":"Type of entity to get.","title":"Entity Type"},"description":"Type of entity to get."}],"responses":{"200":{"description":"Success response with event types tree structure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventTypesTreeResponse"},"example":{"impact_types":[{"id":"SVEYE_BUSINESS_CHANGE_IT","name":"Business Change","event_categories":[{"id":"SVEYE_OWNERSHIP_CHANGES_EC","name":"Ownership changes","event_types":[{"id":"SVEYE_SPINOFFS_ET","name":"Spinoffs"},{"id":"SVEYE_NATIONALIZATION_ET","name":"Nationalization"}]}]}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/insights/v1/languages":{"get":{"tags":["Insights - Enumerations"],"summary":"Loads and returns all available languages","description":"Loads and returns all available languages","operationId":"languages_insights_v1_languages_get","responses":{"200":{"description":"Success response with list of available languages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanguagesResponse"},"example":{"languages":[{"id":"en","name":"English"},{"id":"es","name":"Spanish"},{"id":"fr","name":"French"}],"count":3}}}}},"security":[{"HTTPBearer":[]},{"OAuth2Password":[]}]}},"/entities/v1/industries":{"get":{"tags":["Insights - Entities"],"summary":"Get all available industries","description":"Retrieves a list of all available industries with their IDs and names","operationId":"industries_entities_v1_industries_get","responses":{"200":{"description":"Success response with list of available industries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndustriesResponse"},"example":{"industries":[{"id":"ENVIRONMENTAL_SERVICES_INDUSTRY_ENTITY","name":"Environmental Services Industry"},{"id":"FOOD_BEVERAGE_INDUSTRY_ENTITY","name":"Food & Beverage Industry"},{"id":"TECHNOLOGY_INDUSTRY_ENTITY","name":"Technology Industry"}],"count":3}}}}},"security":[{"HTTPBearer":[]},{"OAuth2Password":[]}]}},"/entities/v1/commodities":{"get":{"tags":["Insights - Entities"],"summary":"Get all available commodities","description":"Retrieves a list of all available commodities with their IDs and names","operationId":"commodities_entities_v1_commodities_get","responses":{"200":{"description":"Success response with list of available commodities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommoditiesResponse"},"example":{"commodities":[{"id":"BOTTLED_WATER_COMMODITY","name":"Bottled Water"},{"id":"COLBYJACK_COMMODITY","name":"Colby-Jack"},{"id":"COTTON_COMMODITY","name":"Cotton"}],"count":3}}}}},"security":[{"HTTPBearer":[]},{"OAuth2Password":[]}]}},"/entities/v1/locations":{"get":{"tags":["Insights - Entities"],"summary":"Get all available locations","description":"Retrieves a paginated list of all available locations with their IDs and names. Use offset and count (page size) to paginate. Response count is the number of items in this page, not a total. The last page is when response count is less than the requested count, or the next page is empty. If response count equals the requested page size, another page may exist.","operationId":"regions_entities_v1_locations_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of locations to skip from the beginning","default":0,"title":"Offset"},"description":"Number of locations to skip from the beginning"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Page size: maximum number of locations to return","default":20,"title":"Count"},"description":"Page size: maximum number of locations to return"},{"name":"search_prefix","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":3},{"type":"null"}],"description":"Prefix to filter locations by name. Must be None or at least 3 characters long.","title":"Search Prefix"},"description":"Prefix to filter locations by name. Must be None or at least 3 characters long."}],"responses":{"200":{"description":"Success response with paginated list of available locations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationsResponse"},"example":{"locations":[{"id":"GERMANY","name":"Germany"},{"id":"REGENSBURG","name":"Regensburg"},{"id":"BAD_NEUSTADT","name":"Bad Neustadt"}],"count":3}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entities/v1/legal_entities":{"get":{"tags":["Insights - Entities"],"summary":"Get all available legal_entities. Cost: 10 credits per entity returned.","description":"Retrieves a paginated list of all available legal_entities with their IDs and names. Use offset and count (page size) to paginate. Response count is the number of items in this page, not a total. The last page is when response count is less than the requested count, or the next page is empty. If response count equals the requested page size, another page may exist.","operationId":"companies_entities_v1_legal_entities_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"search_prefix","in":"query","required":true,"schema":{"type":"string","minLength":3,"description":"Prefix to filter legal_entities by name","title":"Search Prefix"},"description":"Prefix to filter legal_entities by name"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of legal_entities to skip from the beginning","default":0,"title":"Offset"},"description":"Number of legal_entities to skip from the beginning"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Page size: maximum number of legal_entities to return","default":20,"title":"Count"},"description":"Page size: maximum number of legal_entities to return"}],"responses":{"200":{"description":"Success response with paginated list of available legal_entities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalEntitiesResponse"},"example":{"legal_entities":[{"id":"_CO_APPLE_INC","name":"Apple Inc."},{"id":"_CO_MICROSOFT_CORP","name":"Microsoft Corporation"},{"id":"_CO_GOOGLE_LLC","name":"Google LLC"}],"count":3}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entities/v1/companies":{"get":{"tags":["Insights - Entities"],"summary":"Get all available companies. Cost: 10 credits per company returned.","description":"Retrieves a paginated list of all available companies with their IDs and names. Use offset and count (page size) to paginate. Response count is the number of items in this page, not a total. The last page is when response count is less than the requested count, or the next page is empty. If response count equals the requested page size, another page may exist.","operationId":"brands_entities_v1_companies_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"search_prefix","in":"query","required":true,"schema":{"type":"string","minLength":3,"description":"Prefix to filter companies by name","title":"Search Prefix"},"description":"Prefix to filter companies by name"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of companies to skip from the beginning","default":0,"title":"Offset"},"description":"Number of companies to skip from the beginning"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Page size: maximum number of companies to return","default":20,"title":"Count"},"description":"Page size: maximum number of companies to return"}],"responses":{"200":{"description":"Success response with paginated list of available companies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesResponse"},"example":{"companies":[{"id":"_BR_NIKE","name":"Nike"},{"id":"_BR_ADIDAS","name":"Adidas"},{"id":"_BR_APPLE","name":"Apple"}],"count":3}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/entities/v1/companies/details":{"get":{"tags":["Insights - Entities Details"],"summary":"Get details for a list of companies","description":"Retrieves details for a list of companies with their IDs and names","operationId":"company_details_entities_v1_companies_details_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"entity_ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"List of company IDs to get details for","title":"Entity Ids"},"description":"List of company IDs to get details for"}],"responses":{"200":{"description":"Success response with list of company details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDetailsResponse"},"example":{"count":3,"company_details":[{"id":"_BR_NIKE","name":"Nike","event_counts":{"all":100,"last_day":10,"last_month":100},"healthscore":{"overall":80,"detail":{"compliance":80,"cyber_score":80,"esg_score":80,"financial_score":80,"operational_score":80,"regional_score":80},"last_updated":"2021-01-01"},"flags":{"appeared_on_sanction_list":true}},{"id":"_BR_ADIDAS","name":"Adidas","event_counts":{"all":100,"last_day":10,"last_month":100},"healthscore":{"overall":80,"detail":{"compliance":80,"cyber_score":80,"esg_score":80,"financial_score":80,"operational_score":80,"regional_score":80},"last_updated":"2021-01-01"},"flags":{}},{"id":"_BR_APPLE","name":"Apple","event_counts":{"all":100,"last_day":10,"last_month":100},"healthscore":{"overall":80,"detail":{"compliance":80,"cyber_score":80,"esg_score":80,"financial_score":80,"operational_score":80,"regional_score":80},"last_updated":"2021-01-01"},"flags":{}}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/insights/v1/search_event":{"post":{"tags":["Insights - Search"],"summary":"Search Events for data within date range. Cost: 1 credits per event returned.","description":"Search for events within a specified date range and apply various filters.","operationId":"search_insights_v1_search_event_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchEventRequest"}}},"required":true},"responses":{"200":{"description":"Success response with search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchEventResponse"},"example":{"count":25,"cursor":[1755604800000,"scenario_123"],"events":[{"articles_count":1,"entity_id":"CRUDE_OIL_COMMODITY","entity_name":"Crude Oil","entity_type":"commodity","event_category":"SVEYE_REGULATORY_COMPLIANCE_ISSUES_EC","event_category_name":"Regulatory compliance Issues","event_type":"SVEYE_PRODUCT_AND_OPERATIONAL_COMPLIANCE_RISK_ET","event_type_name":"Product and Operational Compliance Risk","impact_type":"SVEYE_BUSINESS_RISK_IT","impact_type_name":"Business Risk","intensity":2,"languages":["en"],"languages_name":["English"],"representative_article_domain":"kissflow.com","representative_article_score":48,"representative_article_title":"Digital Job Safety Analysis Transformation in Oil & Gas | Kissflow","representative_article_title_en":"Digital Job Safety Analysis Transformation in Oil & Gas | Kissflow","representative_article_url":"https://kissflow.com/solutions/oil-and-gas/job-safety-analysis-in-oil-and-gas/","scenario_id":"CRUDE_OIL_COMMODITY#SVEYE_PRODUCT_AND_OPERATIONAL_COMPLIANCE_RISK_ET#9A8A12C2C0A49B0957EB8E33106FC5AB#20250819","timestamp":1755604800000},{"articles_count":1,"entity_id":"NATURAL_GAS_COMMODITY","entity_name":"Natural gas","entity_type":"commodity","event_category":"SVEYE_OPERATIONAL_RISK_EC","event_category_name":"Operational Risk","event_type":"SVEYE_TRADING_RISK_ET","event_type_name":"Trading Risk","impact_type":"SVEYE_BUSINESS_RISK_IT","impact_type_name":"Business Risk","intensity":6,"languages":["en"],"languages_name":["English"],"representative_article_domain":"archyde.com","representative_article_score":83,"representative_article_title":"European Gas Prices Plummet as Zelenskiy and Trump Prepare for Key Meeting","representative_article_title_en":"European Gas Prices Plummet as Zelenskiy and Trump Prepare for Key Meeting","representative_article_url":"https://www.archyde.com/european-gas-prices-plummet-as-zelenskiy-and-trump-prepare-for-key-meeting/","scenario_id":"NATURAL_GAS_COMMODITY#SVEYE_TRADING_RISK_ET#8258BD55BF719EE1AA9D7D6B278AD6E3#20250819","timestamp":1755604800000}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]},{"OAuth2Password":[]}]}},"/insights/v1/search_summary":{"post":{"tags":["Insights - Search"],"summary":"Search Summary for data within date range. Cost: 5 credits per summary returned.","description":"Search for Summaries within a specified date range and apply various filters.","operationId":"search_summary_insights_v1_search_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSummaryRequest"}}},"required":true},"responses":{"200":{"description":"Success response with Summary search results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SummarySearchResponse"},"example":{"count":2,"cursor":[1755799290000,1,"a1b2c3d4-e5f6-7890-abcd-ef1234567890"],"summaries":[{"articles_count":1,"categories":[{"event_category":"SVEYE_OWNERSHIP_CHANGES_EC","event_category_name":"Ownership changes","event_type":"SVEYE_STAKES_AND_ASSETS_ET","event_type_name":"Stakes and assets","impact_type":"SVEYE_BUSINESS_CHANGE_IT","impact_type_name":"Business Change"}],"companies":[{"name":"NODWIN Gaming","sentiment":"neutral"}],"constituents_count":1,"end_time":1755799290000,"end_time_string":"2025-08-21T18:01:30","entity_id":"_BR_F38A91BA_SONY_GROUP_CORP","entity_name":"Sony Group Corp","event_summary":"Sony Group Corp sold its stake in the EVO eSports event to NODWIN Gaming. Sony will continue to support EVO as a global sponsor and partner.","event_title":"Sony Group Corp Sells Stake in EVO eSports Event","locations":[],"sentiment_label":"negative","sentiment_number":-1,"start_time":1755799290000,"start_time_string":"2025-08-21T18:01:30","state":"ended","summary_id":"9268d0ec-84bd-5204-99ef-45da49e09f36"},{"articles_count":2,"categories":[{"event_category":"SVEYE_BUSINESS_EXPANSION_EC","event_category_name":"Business Expansion","event_type":"SVEYE_GROWTH_INITIATIVES_ET","event_type_name":"Growth Initiatives","impact_type":"SVEYE_BUSINESS_GROWTH_IT","impact_type_name":"Business Growth"}],"companies":[],"constituents_count":1,"end_time":1755846163000,"end_time_string":"2025-08-22T07:02:43","entity_id":"_BR_58319F4C_TOYOTA","entity_name":"Toyota","event_summary":"Toyota is opening a new plant in Sorocaba, Brazil by 2026, investing R$11.5 billion.","event_title":"Toyota to Open New Plant in Sorocaba, Brazil, Investing R$11.5 Billion","locations":["Sorocaba, Brazil"],"sentiment_label":"very positive","sentiment_number":2,"start_time":1755828090000,"start_time_string":"2025-08-22T02:01:30","state":"ended","summary_id":"1238d0ec-84bd-5204-99ef-45da49e09f36"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]},{"OAuth2Password":[]}]}},"/insights/v1/supply_chain":{"get":{"tags":["Insights - Search"],"summary":"Get Supply Chain for a given entity. Cost: 100 credits per relation returned.","description":"Get the supply chain for a given entity.","operationId":"get_supply_chain_insights_v1_supply_chain_get","security":[{"HTTPBearer":[]},{"OAuth2Password":[]}],"parameters":[{"name":"entity_id","in":"query","required":true,"schema":{"type":"string","description":"Entity ID to search for - only Companies and Legal Entities are supported","title":"Entity Id"}},{"name":"depth","in":"query","required":true,"schema":{"type":"integer","maximum":3,"minimum":1,"description":"Depth of the supply chain to search for - must be less than or equal to 3","title":"Depth"}}],"responses":{"200":{"description":"Success response with the supply chain graph","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplyChainResponse"},"example":{"count":6,"edges":[{"from":"_BR_9EC8664F_ARM","from_name":"Arm","last_relation_proof_en":"the purported SoC could use Arm's Cortex X4 cores","to":"_BR_9A2B7E87_QUALCOMM","to_name":"Qualcomm","document_count":1,"supply_type":"component"},{"from":"_BR_E35F59E5_TAIWAN_SEMICONDUCTOR_MANUFACTURING","from_name":"Taiwan Semiconductor Manufacturing","last_relation_proof_en":"One major company doing its best to avoid dealing with these tariffs is Taiwan Semiconductor Manufacturing Co. (TSMC), which provides chips to Apple, Nvidia, Qualcomm, and AMD.","to":"_BR_9A2B7E87_QUALCOMM","to_name":"Qualcomm","document_count":1,"supply_type":"component"},{"from":"_BR_3D982F5E_INTEL","from_name":"Intel","last_relation_proof_en":"The Santa Clara, California-based company created the foundry business in 2021 to serve customers including Amazon.com and Qualcomm, while still making chips and wafers for internal use.","to":"_BR_9A2B7E87_QUALCOMM","to_name":"Qualcomm","document_count":1,"supply_type":"component"},{"from":"_BR_4869F179_RESCALE","from_name":"Rescale","last_relation_proof_en":"The company's hundreds of enterprise customers - which include Arm, General Motors Motorsports, Samsung, SLB, and the U.S. Department of Defense - spend over $1 billion annually in high-performance computing infrastructure.","to":"_BR_9EC8664F_ARM","to_name":"Arm","document_count":1,"supply_type":"production_support_service"},{"from":"_BR_72024ABB_ASML","from_name":"Asml","last_relation_proof_en":"In its latest quarter, ASML said that 35% of new system sales were in Taiwan. You can bet that the majority of sales in Taiwan are going to Taiwan Semiconductor Manufacturing.","to":"_BR_E35F59E5_TAIWAN_SEMICONDUCTOR_MANUFACTURING","to_name":"Taiwan Semiconductor Manufacturing","document_count":2,"supply_type":"machinery"},{"from":"_BR_1B355C10_ACCENTURE","from_name":"Accenture","last_relation_proof_en":"Specifically, Intel will hire the company Accenture.","to":"_BR_3D982F5E_INTEL","to_name":"Intel","document_count":3,"supply_type":"indirect_support_service"}],"nodes":[{"id":"_BR_9A2B7E87_QUALCOMM","name":"Qualcomm","tier":0},{"id":"_BR_9EC8664F_ARM","name":"Arm","tier":1},{"id":"_BR_3D982F5E_INTEL","name":"Intel","tier":1},{"id":"_BR_E35F59E5_TAIWAN_SEMICONDUCTOR_MANUFACTURING","name":"Taiwan Semiconductor Manufacturing","tier":1},{"id":"_BR_1B355C10_ACCENTURE","name":"Accenture","tier":2},{"id":"_BR_72024ABB_ASML","name":"Asml","tier":2},{"id":"_BR_4869F179_RESCALE","name":"Rescale","tier":2}],"root_entity_id":"_BR_9A2B7E87_QUALCOMM","root_entity_name":"Qualcomm"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AllEventTypesListResponse":{"properties":{"count":{"type":"integer","title":"Count"},"event_types":{"items":{"type":"string"},"type":"array","title":"Event Types"}},"type":"object","required":["count","event_types"],"title":"AllEventTypesListResponse","description":"Response model for the event types list endpoint."},"ArticleResult":{"properties":{"article_id":{"type":"integer","title":"Article Id","description":"The article's unique identifier."},"time":{"type":"string","title":"Time","description":"Article publication time in ISO 8601 format."},"language":{"type":"string","maxLength":2,"minLength":2,"title":"Language","description":"ISO 2-letter language code."},"title":{"type":"string","title":"Title","description":"The title of the article."},"url":{"type":"string","title":"Url","description":"The URL of the article."},"domain":{"type":"string","title":"Domain","description":"The 2nd level domain of the URL. (Maps to SGROUP)."},"group_id":{"type":"string","title":"Group Id","description":"Similarity group identifier."},"watchlist_id":{"type":"string","title":"Watchlist Id","description":"The watchlist ID for the scenario."},"client_watchlist_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Watchlist Id","description":"The client watchlist ID for the scenario."},"scenarios":{"items":{"$ref":"#/components/schemas/ArticleScenario"},"type":"array","title":"Scenarios","description":"Scenarios where this article appeared."}},"type":"object","required":["article_id","time","language","title","url","domain","group_id","watchlist_id","scenarios"],"title":"ArticleResult","description":"Article with watchlist info and all linked scenarios."},"ArticleScenario":{"properties":{"scenario_id":{"type":"string","title":"Scenario Id","description":"A unique identifier for the scenario."},"entity_id":{"type":"string","title":"Entity Id","description":"The entity's unique identifier."},"event_type_id":{"type":"string","title":"Event Type Id","description":"The event type's unique identifier."},"time":{"type":"string","title":"Time","description":"ISO 8601 timestamp when the scenario is active."},"intensity":{"type":"integer","maximum":1000.0,"minimum":0.0,"title":"Intensity","description":"Metric (0-1000) for how significant the event is for the entity."},"score":{"type":"integer","maximum":100.0,"minimum":0.0,"title":"Score","description":"Scale (0-100) of how well the article describes the scenario."}},"type":"object","required":["scenario_id","entity_id","event_type_id","time","intensity","score"],"title":"ArticleScenario","description":"A scenario occurrence linked to an article."},"CommoditiesResponse":{"properties":{"count":{"type":"integer","title":"Count"},"commodities":{"items":{"$ref":"#/components/schemas/Entity"},"type":"array","title":"Commodities"}},"type":"object","required":["count","commodities"],"title":"CommoditiesResponse","description":"Response model for commodities endpoint."},"CompaniesResponse":{"properties":{"count":{"type":"integer","title":"Count","description":"Number of companies in this page, not the total number of matching results."},"companies":{"items":{"$ref":"#/components/schemas/Entity"},"type":"array","title":"Companies"}},"type":"object","required":["count","companies"],"title":"CompaniesResponse","description":"Response model for the companies endpoint."},"CompanyDetailsFlags":{"properties":{"appeared_on_sanction_list":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Appeared On Sanction List"}},"type":"object","title":"CompanyDetailsFlags","description":"Response model for a company details flags."},"CompanyDetailsHealthscore":{"properties":{"overall":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Overall"},"detail":{"anyOf":[{"$ref":"#/components/schemas/HealthscoreDetail"},{"type":"null"}]},"last_updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Updated"}},"type":"object","title":"CompanyDetailsHealthscore","description":"Response model for a company details healthscore."},"CompanyDetailsItem":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"event_counts":{"anyOf":[{"$ref":"#/components/schemas/EventCounts"},{"type":"null"}]},"healthscore":{"anyOf":[{"$ref":"#/components/schemas/CompanyDetailsHealthscore"},{"type":"null"}]},"flags":{"anyOf":[{"$ref":"#/components/schemas/CompanyDetailsFlags"},{"type":"null"}]}},"type":"object","required":["id","name"],"title":"CompanyDetailsItem","description":"Response model for a company details item."},"CompanyDetailsResponse":{"properties":{"count":{"type":"integer","title":"Count"},"company_details":{"items":{"$ref":"#/components/schemas/CompanyDetailsItem"},"type":"array","title":"Company Details"}},"type":"object","required":["count","company_details"],"title":"CompanyDetailsResponse","description":"Response model for the company details endpoint."},"DeleteMonitoringEntitiesRequest":{"properties":{"entity_ids":{"items":{"type":"string"},"type":"array","title":"Entity Ids"}},"type":"object","required":["entity_ids"],"title":"DeleteMonitoringEntitiesRequest"},"Entity":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"Entity","description":"Represents an entity (Commodity, Language, Region ...) with its id and name."},"EntityTypesResponse":{"properties":{"count":{"type":"integer","title":"Count"},"entity_types":{"items":{"type":"string"},"type":"array","title":"Entity Types"}},"type":"object","required":["count","entity_types"],"title":"EntityTypesResponse","description":"Response model for the entity types' endpoint."},"EventCategoriesResponse":{"properties":{"count":{"type":"integer","title":"Count"},"event_categories":{"items":{"type":"string"},"type":"array","title":"Event Categories"}},"type":"object","required":["count","event_categories"],"title":"EventCategoriesResponse","description":"Response model for the event categories' endpoint."},"EventCounts":{"properties":{"all":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"All"},"last_day":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Day"},"last_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Month"}},"type":"object","title":"EventCounts","description":"Response model for a company details event counts."},"EventModel":{"properties":{"articles_count":{"type":"integer","title":"Articles Count"},"entity_id":{"type":"string","title":"Entity Id"},"entity_name":{"type":"string","title":"Entity Name"},"entity_type":{"type":"string","title":"Entity Type"},"event_category":{"type":"string","title":"Event Category"},"event_category_name":{"type":"string","title":"Event Category Name"},"event_type":{"type":"string","title":"Event Type"},"event_type_name":{"type":"string","title":"Event Type Name"},"impact_type":{"type":"string","title":"Impact Type"},"impact_type_name":{"type":"string","title":"Impact Type Name"},"intensity":{"type":"integer","title":"Intensity"},"languages":{"items":{"type":"string"},"type":"array","title":"Languages"},"languages_name":{"items":{"type":"string"},"type":"array","title":"Languages Name"},"representative_article_score":{"type":"integer","title":"Representative Article Score"},"representative_article_domain":{"type":"string","title":"Representative Article Domain"},"representative_article_title":{"type":"string","title":"Representative Article Title"},"representative_article_title_en":{"type":"string","title":"Representative Article Title En"},"representative_article_url":{"type":"string","title":"Representative Article Url"},"scenario_id":{"type":"string","title":"Scenario Id"},"timestamp":{"type":"integer","title":"Timestamp"}},"type":"object","required":["articles_count","entity_id","entity_name","entity_type","event_category","event_category_name","event_type","event_type_name","impact_type","impact_type_name","intensity","languages","languages_name","representative_article_score","representative_article_domain","representative_article_title","representative_article_title_en","representative_article_url","scenario_id","timestamp"],"title":"EventModel"},"EventTypesListResponse":{"properties":{"count":{"type":"integer","title":"Count"},"event_types":{"items":{"type":"string"},"type":"array","title":"Event Types"}},"type":"object","required":["count","event_types"],"title":"EventTypesListResponse","description":"Response model for the event types list endpoint."},"EventTypesTreeResponse":{"properties":{"impact_types":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Impact Types"}},"type":"object","required":["impact_types"],"title":"EventTypesTreeResponse","description":"Response model for the event types' endpoint."},"HTTPError":{"properties":{"detail":{"type":"string","title":"Detail","description":"Human-readable error message."}},"type":"object","required":["detail"],"title":"HTTPError","description":"Body returned by FastAPI HTTPException."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthscoreDetail":{"properties":{"compliance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Compliance"},"cyber_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cyber Score"},"esg_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Esg Score"},"financial_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Financial Score"},"operational_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Operational Score"},"regional_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Regional Score"}},"type":"object","title":"HealthscoreDetail","description":"Response model for a company details healthscore detail."},"ImpactTypesResponse":{"properties":{"count":{"type":"integer","title":"Count"},"impact_types":{"items":{"type":"string"},"type":"array","title":"Impact Types"}},"type":"object","required":["count","impact_types"],"title":"ImpactTypesResponse","description":"Response model for the impact types' endpoint."},"IndustriesResponse":{"properties":{"count":{"type":"integer","title":"Count"},"industries":{"items":{"$ref":"#/components/schemas/Entity"},"type":"array","title":"Industries"}},"type":"object","required":["count","industries"],"title":"IndustriesResponse","description":"Response model for industries endpoint."},"LanguagesResponse":{"properties":{"count":{"type":"integer","title":"Count"},"languages":{"items":{"$ref":"#/components/schemas/Entity"},"type":"array","title":"Languages"}},"type":"object","required":["count","languages"],"title":"LanguagesResponse","description":"Response model for the languages' endpoint."},"LegalEntitiesResponse":{"properties":{"count":{"type":"integer","title":"Count","description":"Number of legal entities in this page, not the total number of matching results."},"legal_entities":{"items":{"$ref":"#/components/schemas/Entity"},"type":"array","title":"Legal Entities"}},"type":"object","required":["count","legal_entities"],"title":"LegalEntitiesResponse","description":"Response model for the legal_entities endpoint."},"LocationsResponse":{"properties":{"count":{"type":"integer","title":"Count","description":"Number of locations in this page, not the total number of matching results."},"locations":{"items":{"$ref":"#/components/schemas/Entity"},"type":"array","title":"Locations"}},"type":"object","required":["count","locations"],"title":"LocationsResponse","description":"Response model for the regions' endpoint."},"MonitoringRequestResponse":{"properties":{"monitoring_request_id":{"type":"string","title":"Monitoring Request Id"},"status":{"type":"string","enum":["processing_validation","validated","error"],"title":"Status"},"entities_received":{"type":"integer","title":"Entities Received"}},"type":"object","required":["monitoring_request_id","status","entities_received"],"title":"MonitoringRequestResponse"},"MonitoringResultStatus":{"properties":{"watchlist_id":{"type":"string","title":"Watchlist Id","description":"The watchlist ID for the monitoring request."},"batch_time":{"type":"string","title":"Batch Time","description":"The batch time."},"status":{"type":"string","enum":["processing","ready","not_ready"],"title":"Status","description":"The current status of the job."},"message":{"type":"string","title":"Message","description":"A message describing the status."}},"type":"object","required":["watchlist_id","batch_time","status","message"],"title":"MonitoringResultStatus","description":"Represents the status of a monitoring job results at a given batch time."},"MonitoringStatusResponse":{"properties":{"monitoring_request_id":{"type":"string","title":"Monitoring Request Id"},"status":{"type":"string","enum":["processing_validation","validated","error"],"title":"Status"},"message":{"type":"string","title":"Message"},"entities_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Entities Count"},"new_entities_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"New Entities Count"},"deleted_entities_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Deleted Entities Count"},"updated_entities_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Updated Entities Count"},"error_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Error Count"},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/WatchlistRequestEntityError"},"type":"array"},{"type":"null"}],"title":"Errors"}},"type":"object","required":["monitoring_request_id","status","message"],"title":"MonitoringStatusResponse"},"PaginatedResponse_ArticleResult_":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/ArticleResult"},"type":"array","title":"Data"}},"type":"object","required":["pagination","data"],"title":"PaginatedResponse[ArticleResult]"},"PaginatedResponse_ScenarioResult_":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/ScenarioResult"},"type":"array","title":"Data"}},"type":"object","required":["pagination","data"],"title":"PaginatedResponse[ScenarioResult]"},"PaginationInfo":{"properties":{"limit":{"type":"integer","title":"Limit","description":"Maximum number of items returned"},"offset":{"type":"integer","title":"Offset","description":"Number of items skipped"},"total":{"type":"integer","title":"Total","description":"Total number of items available"}},"type":"object","required":["limit","offset","total"],"title":"PaginationInfo","description":"Pagination metadata."},"ProductMonitoringConfiguration":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"}},"type":"object","required":["active"],"title":"ProductMonitoringConfiguration"},"ProductScreeningConfiguration":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"time_window_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Time Window Months"}},"type":"object","required":["active","time_window_months"],"title":"ProductScreeningConfiguration"},"ProjectConfigurationResponse":{"properties":{"project_id":{"type":"string","title":"Project Id"},"project_name":{"type":"string","title":"Project Name"},"watchlist_id":{"type":"string","title":"Watchlist Id"},"client_watchlist_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Watchlist Id"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type"},"screening_configuration":{"anyOf":[{"$ref":"#/components/schemas/ProductScreeningConfiguration"},{"type":"null"}]},"monitoring_configuration":{"anyOf":[{"$ref":"#/components/schemas/ProductMonitoringConfiguration"},{"type":"null"}]}},"type":"object","required":["project_id","project_name","watchlist_id","client_watchlist_id","entity_type","screening_configuration","monitoring_configuration"],"title":"ProjectConfigurationResponse"},"ScenarioArticle":{"properties":{"article_id":{"type":"integer","title":"Article Id","description":"The article's unique identifier."},"time":{"type":"string","title":"Time","description":"Article publication time in ISO 8601 format."},"language":{"type":"string","maxLength":2,"minLength":2,"title":"Language","description":"ISO 2-letter language code."},"title":{"type":"string","title":"Title","description":"The title of the article."},"url":{"type":"string","title":"Url","description":"The URL of the article."},"domain":{"type":"string","title":"Domain","description":"The 2nd level domain of the URL. (Maps to SGROUP)."},"group_id":{"type":"string","title":"Group Id","description":"Similarity group identifier."},"score":{"type":"integer","maximum":100.0,"minimum":0.0,"title":"Score","description":"Scale (0-100) of how well the article describes the scenario."}},"type":"object","required":["article_id","time","language","title","url","domain","group_id","score"],"title":"ScenarioArticle","description":"An article linked to as scenario."},"ScenarioResult":{"properties":{"scenario_id":{"type":"string","title":"Scenario Id","description":"A unique identifier for the scenario."},"entity_id":{"type":"string","title":"Entity Id","description":"The entity's unique identifier."},"event_type_id":{"type":"string","title":"Event Type Id","description":"The event type's unique identifier."},"time":{"type":"string","title":"Time","description":"ISO 8601 timestamp when the scenario is active."},"intensity":{"type":"integer","maximum":1000.0,"minimum":0.0,"title":"Intensity","description":"Metric (0-1000) for how significant the event is for the entity."},"watchlist_id":{"type":"string","title":"Watchlist Id","description":"The watchlist ID for the scenario."},"client_watchlist_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Watchlist Id","description":"The client watchlist ID for the scenario."},"abs_count":{"type":"integer","minimum":0.0,"title":"Abs Count","description":"Number of articles supporting the scenario."},"articles":{"items":{"$ref":"#/components/schemas/ScenarioArticle"},"type":"array","title":"Articles","description":"An array of Article objects that support this scenario."}},"type":"object","required":["scenario_id","entity_id","event_type_id","time","intensity","watchlist_id","abs_count"],"title":"ScenarioResult","description":"Scenario with watchlist info and all supporting articles."},"ScreeningRequestResponse":{"properties":{"screening_id":{"type":"string","title":"Screening Id"},"status":{"type":"string","enum":["processing_validation","validated","error"],"title":"Status"},"entities_received":{"type":"integer","title":"Entities Received"}},"type":"object","required":["screening_id","status","entities_received"],"title":"ScreeningRequestResponse"},"ScreeningResultStatus":{"properties":{"screening_id":{"type":"string","title":"Screening Id","description":"The unique ID for the screening request."},"status":{"type":"string","enum":["processing","ready","not_ready"],"title":"Status","description":"The current status of the job."},"message":{"type":"string","title":"Message","description":"A human-readable message."},"entities_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Entities Count","description":"The total number of entities in the job."},"processing_start_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Processing Start Time","description":"ISO 8601 timestamp."},"screening_period_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screening Period Start","description":"ISO 8601 date."},"screening_period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screening Period End","description":"ISO 8601 date."}},"type":"object","required":["screening_id","status","message"],"title":"ScreeningResultStatus","description":"Represents the status of a screening job."},"ScreeningStatusResponse":{"properties":{"screening_id":{"type":"string","title":"Screening Id"},"status":{"type":"string","enum":["processing_validation","validated","error"],"title":"Status"},"message":{"type":"string","title":"Message"},"entities_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Entities Count"},"error_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Error Count"},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/WatchlistRequestEntityError"},"type":"array"},{"type":"null"}],"title":"Errors"}},"type":"object","required":["screening_id","status","message"],"title":"ScreeningStatusResponse"},"SearchEventRequest":{"properties":{"date_from":{"type":"string","format":"date","title":"Date From","description":"Start date for the search range (YYYY-MM-DD)"},"date_to":{"type":"string","format":"date","title":"Date To","description":"End date for the search range (YYYY-MM-DD). Must be after date_from."},"languages":{"anyOf":[{"items":{"type":"string","enum":["ar","cs","en","fr","de","zh","it","ja","ko","pt","ru","es"]},"type":"array"},{"type":"null"}],"title":"Languages","description":"List of language codes to filter by."},"entity_type":{"anyOf":[{"items":{"type":"string","enum":["commodity","company","industry","legal_entity","location"]},"type":"array"},{"type":"string","enum":["commodity","company","industry","legal_entity","location"]},{"type":"null"}],"title":"Entity Type","description":"Type of entity to search."},"count":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Count","description":"Number of results to return","default":100},"sort_by":{"anyOf":[{"items":{"type":"string","enum":["intensity","-intensity","timestamp","-timestamp","impact_type_name","-impact_type_name","event_category_name","-event_category_name","event_type_name","-event_type_name","articles_count","-articles_count","representative_article_domain","-representative_article_domain","representative_article_title","-representative_article_title","representative_article_score","-representative_article_score","representative_article_title_en","key","-key"]},"type":"array"},{"type":"null"}],"title":"Sort By","description":"List of fields to sort by. Prefix with \"-\" for descending order.","default":["timestamp","-intensity"]},"cursor":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Cursor","description":"Pagination cursor for retrieving next page. Must match the length of sort_by when provided."},"intensity_min":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Intensity Min","description":"Minimum intensity filter. Must be <= intensity_max.","default":1},"intensity_max":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Intensity Max","description":"Maximum intensity filter. Must be >= intensity_min.","default":1000},"entity_ids":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Entity Ids","description":"Filter by specific entity IDs. Can be a single string or list of strings. Valid entity IDs can be retrieved from the corresponding entity endpoints."},"impact_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Impact Types","description":"Filter by SvEye taxonomy elements IDs (Impact Types)."},"event_categories":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event Categories","description":"Filter by SvEye taxonomy elements IDs (Event Categories)."},"event_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event Types","description":"Filter by SvEye taxonomy elements IDs (Event Types)."}},"additionalProperties":false,"type":"object","required":["date_from","date_to"],"title":"SearchEventRequest","description":"Request model for the search event endpoint.","examples":[{"count":10,"date_from":"2025-01-01","date_to":"2025-11-25","entity_ids":["_CO_E8284ACA_ORGA_HOLDING"],"entity_type":"legal_entity","intensity_max":1000,"intensity_min":1,"languages":["en"],"sort_by":["timestamp","-intensity"]},{"count":10,"date_from":"2025-01-01","date_to":"2025-11-25","entity_ids":["_BR_5E83CEC8_SSATORIUSEU"],"entity_type":"company","intensity_max":1000,"intensity_min":1,"languages":["en"],"sort_by":["timestamp","-intensity"]},{"count":10,"date_from":"2025-01-01","date_to":"2025-11-25","entity_type":"commodity","intensity_max":1000,"intensity_min":1,"languages":["en"],"sort_by":["timestamp","-intensity"]}]},"SearchEventResponse":{"properties":{"count":{"type":"integer","title":"Count"},"cursor":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Cursor"},"events":{"items":{"$ref":"#/components/schemas/EventModel"},"type":"array","title":"Events"}},"type":"object","required":["count","cursor","events"],"title":"SearchEventResponse","description":"Response model for the search event endpoint."},"SearchSummaryRequest":{"properties":{"date_from":{"type":"string","format":"date","title":"Date From","description":"Start date for the search range (YYYY-MM-DD)"},"date_to":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To","description":"End date for the search range (YYYY-MM-DD). End date of the search range."},"entity_type":{"anyOf":[{"items":{"type":"string","enum":["commodity","company","industry","legal_entity","location"]},"type":"array"},{"type":"string","enum":["commodity","company","industry","legal_entity","location"]},{"type":"null"}],"title":"Entity Type","description":"Type of entity to search."},"count":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Count","description":"Number of results to return","default":100},"sort_by":{"anyOf":[{"items":{"type":"string","enum":["start_time","-start_time","end_time","-end_time","event_title","-event_title","event_category_name","-event_category_name","event_type_name","-event_type_name","impact_type_name","-impact_type_name","sentiment_number","-sentiment_number","articles_count","-articles_count"]},"type":"array"},{"type":"null"}],"title":"Sort By","description":"List of fields to sort by. Prefix with \"-\" for descending order.","default":["start_time","-articles_count"]},"cursor":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Cursor","description":"Pagination cursor for the next page. Pass the cursor from a previous response unchanged, with the same sort_by. The returned cursor includes a UUID tie-breaker, so it is one element longer than sort_by."},"entity_ids":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Entity Ids","description":"Filter by specific entity IDs. Can be a single string or list of strings. Valid entity IDs can be retrieved from the corresponding entity endpoints."},"impact_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Impact Types","description":"Filter by SvEye taxonomy elements IDs (Impact Types)."},"event_categories":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event Categories","description":"Filter by SvEye taxonomy elements IDs (Event Categories)."},"event_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event Types","description":"Filter by SvEye taxonomy elements IDs (Event Types)."},"sentiment_list":{"anyOf":[{"items":{"type":"string","enum":["very positive","positive","neutral","negative","very negative"]},"type":"array"},{"type":"null"}],"title":"Sentiment List","description":"Filter by sentiment list. Valid values are: 'very positive', 'positive', 'neutral', 'negative', 'very negative'."},"article_count_min":{"type":"integer","title":"Article Count Min","description":"Filter by minimum number of articles.","default":0},"article_count_max":{"type":"integer","title":"Article Count Max","description":"Filter by maximum number of articles.","default":10000}},"additionalProperties":false,"type":"object","required":["date_from","date_to"],"title":"SearchSummaryRequest","description":"Request model for the search summary endpoint.","examples":[{"count":10,"date_from":"2025-01-01","date_to":"2025-11-25","entity_ids":["_BR_5E83CEC8_SSATORIUSEU"],"entity_type":"company","sentiment_list":["very positive","positive"],"sort_by":["start_time","-articles_count"]}]},"Summary":{"properties":{"articles_count":{"type":"integer","title":"Articles Count","description":"Number of articles related to this event"},"categories":{"items":{"$ref":"#/components/schemas/SummaryEventCategory"},"type":"array","title":"Categories","description":"List of event categories"},"companies":{"items":{"$ref":"#/components/schemas/SummaryCompany"},"type":"array","title":"Companies","description":"List of companies mentioned in the event"},"constituents_count":{"type":"integer","title":"Constituents Count","description":"Number of constituents related to this event"},"end_time":{"type":"integer","title":"End Time","description":"Event end time in milliseconds (Unix timestamp)"},"end_time_string":{"type":"string","title":"End Time String","description":"Event end time as ISO 8601 string"},"entity_id":{"type":"string","title":"Entity Id","description":"Unique identifier for the entity"},"entity_name":{"type":"string","title":"Entity Name","description":"Name of the entity"},"event_summary":{"type":"string","title":"Event Summary","description":"Detailed summary of the event"},"event_title":{"type":"string","title":"Event Title","description":"Title of the event"},"locations":{"items":{"type":"string"},"type":"array","title":"Locations","description":"List of locations mentioned in the event"},"sentiment_label":{"type":"string","title":"Sentiment Label","description":"Overall sentiment label (e.g., neutral, positive, negative, very positive)"},"sentiment_number":{"type":"integer","title":"Sentiment Number","description":"Sentiment as a number (-2 to 2)"},"start_time":{"type":"integer","title":"Start Time","description":"Event start time in milliseconds (Unix timestamp)"},"start_time_string":{"type":"string","title":"Start Time String","description":"Event start time as ISO 8601 string"},"state":{"type":"string","title":"State","description":"Current state of the event (e.g., ongoing, ended)"},"entity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Type","description":"Type of the entity"},"summary_id":{"type":"string","title":"Summary Id","description":"Summary ID"}},"type":"object","required":["articles_count","categories","constituents_count","end_time","end_time_string","entity_id","entity_name","event_summary","event_title","sentiment_label","sentiment_number","start_time","start_time_string","state","summary_id"],"title":"Summary","description":"Single Summary"},"SummaryCompany":{"properties":{"name":{"type":"string","title":"Name","description":"Company name"},"sentiment":{"type":"string","title":"Sentiment","description":"Sentiment associated with the company (e.g., neutral, positive, negative)"}},"type":"object","required":["name","sentiment"],"title":"SummaryCompany","description":"Company mentioned in an Summary event"},"SummaryEventCategory":{"properties":{"impact_type":{"type":"string","title":"Impact Type","description":"Impact type identifier"},"impact_type_name":{"type":"string","title":"Impact Type Name","description":"Human-readable impact type name"},"event_category":{"type":"string","title":"Event Category","description":"Event category identifier"},"event_category_name":{"type":"string","title":"Event Category Name","description":"Human-readable event category name"},"event_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Type","description":"Event type identifier"},"event_type_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Type Name","description":"Human-readable event type name"}},"type":"object","required":["impact_type","impact_type_name","event_category","event_category_name"],"title":"SummaryEventCategory","description":"Category information for an Summary event"},"SummarySearchResponse":{"properties":{"summaries":{"items":{"$ref":"#/components/schemas/Summary"},"type":"array","title":"Summaries","description":"List of Summaries matching the search criteria"},"count":{"type":"integer","title":"Count","description":"Total number of Summaries matching the search criteria"},"cursor":{"anyOf":[{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"type":"array"},{"type":"null"}],"title":"Cursor","description":"Cursor for pagination. Pass this value back unchanged with the same sort_by to retrieve the next page. Includes a UUID tie-breaker, so it is one element longer than sort_by."}},"type":"object","required":["summaries","count","cursor"],"title":"SummarySearchResponse","description":"Response model for Summary search endpoint","example":{"count":1,"cursor":[1755799290000,1,"a1b2c3d4-e5f6-7890-abcd-ef1234567890"],"summaries":[{"articles_count":1,"categories":[{"event_category":"SVEYE_OWNERSHIP_CHANGES_EC","event_category_name":"Ownership changes","event_type":"SVEYE_STAKES_AND_ASSETS_ET","event_type_name":"Stakes and assets","impact_type":"SVEYE_BUSINESS_CHANGE_IT","impact_type_name":"Business Change"}],"companies":[{"name":"NODWIN Gaming","sentiment":"neutral"}],"constituents_count":1,"end_time":1755799290000,"end_time_string":"2025-08-21T18:01:30","entity_id":"_BR_F38A91BA_SONY_GROUP_CORP","entity_name":"Sony Group Corp","event_summary":"Sony Group Corp sold its stake in the EVO eSports event to NODWIN Gaming.","event_title":"Sony Group Corp Sells Stake in EVO eSports Event","locations":[],"sentiment_label":"negative","sentiment_number":-1,"start_time":1755799290000,"start_time_string":"2025-08-21T18:01:30","state":"ended","summary_id":"9268d0ec-84bd-5204-99ef-45da49e09f36"}]}},"SupplyChainEdge":{"properties":{"from":{"type":"string","title":"From","description":"Source entity ID"},"from_name":{"type":"string","title":"From Name","description":"Source entity name"},"last_relation_proof_en":{"type":"string","title":"Last Relation Proof En","description":"Last proof of the relation from latest article"},"to":{"type":"string","title":"To","description":"Target entity ID"},"to_name":{"type":"string","title":"To Name","description":"Target entity name"},"document_count":{"type":"integer","title":"Document Count","description":"Number of articles constructing the edge"},"supply_type":{"type":"string","title":"Supply Type","description":"Supply type"}},"type":"object","required":["from","from_name","last_relation_proof_en","to","to_name","document_count","supply_type"],"title":"SupplyChainEdge"},"SupplyChainNode":{"properties":{"id":{"type":"string","title":"Id","description":"Entity ID"},"name":{"type":"string","title":"Name","description":"Entity name"},"tier":{"type":"integer","title":"Tier","description":"Tier"}},"type":"object","required":["id","name","tier"],"title":"SupplyChainNode"},"SupplyChainResponse":{"properties":{"count":{"type":"integer","title":"Count","description":"Total number of edges in the supply chain"},"edges":{"items":{"$ref":"#/components/schemas/SupplyChainEdge"},"type":"array","title":"Edges","description":"List of edges in the supply chain"},"nodes":{"items":{"$ref":"#/components/schemas/SupplyChainNode"},"type":"array","title":"Nodes","description":"List of nodes in the supply chain"},"root_entity_id":{"type":"string","title":"Root Entity Id","description":"Root entity ID"},"root_entity_name":{"type":"string","title":"Root Entity Name","description":"Root entity name"}},"type":"object","required":["count","edges","nodes","root_entity_id","root_entity_name"],"title":"SupplyChainResponse","description":"Response model for the supply chain endpoint"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WatchlistEntity-Input":{"properties":{"entity_id":{"type":"string","minLength":1,"title":"Entity Id"},"name":{"type":"string","minLength":1,"title":"Name"},"metadata":{"anyOf":[{"$ref":"#/components/schemas/WatchlistEntityMetadata"},{"type":"null"}]}},"type":"object","required":["entity_id","name"],"title":"WatchlistEntity"},"WatchlistEntity-Output":{"additionalProperties":true,"type":"object"},"WatchlistEntityMetadata":{"properties":{"aliases":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Aliases"},"size_of_supplier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Size Of Supplier"},"naics":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Naics"},"ticker_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker Symbol"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"district":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"District"},"city_nonlatin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City Nonlatin"},"district_nonlatin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"District Nonlatin"},"state_province":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Province"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"}},"type":"object","title":"WatchlistEntityMetadata"},"WatchlistRequestEntityError":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"error":{"type":"string","title":"Error"}},"type":"object","required":["entity_id","error"],"title":"WatchlistRequestEntityError"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer","description":"Paste a JWT access token obtained from `POST /token`."},"OAuth2Password":{"type":"oauth2","description":"Sign in with your API username and password; the token is retrieved and used automatically.","flows":{"password":{"tokenUrl":"https://api.semantic-visions.com/token","scopes":{}}}}}},"tags":[{"name":"Use Cases","description":"\n## Analyzing a List of Companies\n\nFive calls take you from names to signals:\n\n1. **Get an access token** with `POST /token` (see **Authentication** in the Introduction).\n2. **Resolve names to IDs** with `GET /entities/v1/companies?search_prefix=Nike`, or\n   `GET /entities/v1/legal_entities` for registered names such as \"Škoda Auto a.s.\". Store the mapping.\n3. **Get a health snapshot** for the whole list with `GET /entities/v1/companies/details?entity_ids=…`.\n4. **Search summaries** to read what happened, e.g. the most-covered negative developments:\n```\ncurl -X POST 'https://api.semantic-visions.com/insights/v1/search_summary' \\\n  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' -H 'Content-Type: application/json' \\\n  -d '{\n    \"entity_ids\": [\"_BR_NIKE\", \"_BR_ADIDAS\", \"_BR_58319F4C_TOYOTA\"],\n    \"date_from\": \"2025-10-14\", \"date_to\": \"2026-10-14\",\n    \"sentiment_list\": [\"negative\", \"very negative\"],\n    \"sort_by\": [\"-articles_count\"],\n    \"count\": 25\n  }'\n```\n5. **Search events** with `POST /insights/v1/search_event` for the signal-level timeline. To narrow by\n   topic, take filter IDs from `GET /insights/v1/event_types_tree?entity_type=company`.\n\nTo get the next page of a search, send the same body again with `cursor` set to the cursor from the last\nresponse. Stop when the response cursor is null or fewer rows come back than `count`.\n\n## Analyzing a List of Commodities\n\nThe flow is the same, with two differences:\n\n* Commodity IDs come from one complete list instead of a search: load `GET /entities/v1/commodities` once\n  and match your names locally.\n* The taxonomy is commodity-specific: use `GET /insights/v1/event_types_tree?entity_type=commodity` and pick\n  impact types or categories such as supply disruption or price movement.\n\nLocations and industries work the same way (`GET /entities/v1/locations?search_prefix=Ger`,\n`GET /entities/v1/industries`). To see which suppliers sit behind a company, call\n`GET /insights/v1/supply_chain?entity_id=_BR_NIKE&depth=1`.\n\n## Watchlist Monitoring and Screening\n\nWatchlists suit a fixed portfolio of entities identified by your own IDs, for example a supplier base.\n\n1. **Find your watchlist** with `GET /watchlists/v1/project_configuration`. Each project has a\n   `watchlist_id` used in all other Watchlists calls.\n2. **Submit entities**: `POST /watchlists/v1/monitoring/{watchlist_id}` adds or updates entities in a\n   standing list that is checked every hour; `POST /watchlists/v1/screening/{watchlist_id}` runs a one-time\n   check of a list over a date range.\n3. **Wait for validation**: submissions are processed asynchronously. Poll the returned request ID until\n   its status is `validated` (or `error`, with the reasons per entity).\n4. **Download results**: check the results status, then page through scenarios and their articles with\n   `limit` and `offset`. Monitoring results are produced per hourly `batch_time`\n   (ISO 8601, e.g. `2026-02-02T14:00:00`).\n"},{"name":"Watchlists - Projects","description":"Start here for Watchlists. Lists the projects your account can access. Each project tracks one entity type and has a `watchlist_id`, used in every other Watchlists call, and optionally your own `client_watchlist_id`. One user can access several projects and one project can be shared by several users; contact us to change access or create users for a project."},{"name":"Watchlists - Requests","description":"Send your entities to Semantic Visions, identified by your own `entity_id`.\n\n* **Monitoring** keeps a standing list that is checked every hour. Submitting adds or updates entities (matched on `entity_id`), deleting removes them, and you can read the current list back.\n* **Screening** is a one-time check of a list over a date range (`start_date`, `end_date`).\n\nSubmissions are asynchronous: the call returns `202 Accepted` with a request ID. Poll the status endpoint until the request is `validated`, or `error` with the reasons per entity."},{"name":"Watchlists - Results","description":"Download what was found for your entities. Results are **scenarios**: one entity and one event type at a point in time, with an `intensity` (1–1000) and the number of supporting articles. The articles endpoints return the news articles behind them.\n\nMonitoring results are produced for each hourly `batch_time` (ISO 8601, e.g. `2026-02-02T14:00:00`); screening results belong to a `screening_id`. Check the results status first, then page through results with `limit` (up to 1000) and `offset`."},{"name":"Insights - Entities","description":"Turn names into Semantic Visions entity IDs; every Insights search works on IDs.\n\n* **Companies** (brands, `_BR_…`) and **legal entities** (registered companies, `_CO_…`) are searched by name prefix and cost 10 credits per row returned, so keep `count` small and store the mapping.\n* **Commodities** and **industries** are complete lists; load them once and match names locally.\n* **Locations** are searched by name prefix.\n\nCommodity, industry and location lookups are free."},{"name":"Insights - Entities Details","description":"A health snapshot for a list of companies in one call: the overall health score (−100 to 100) with six sub-scores, event counts, and whether the company appeared on a sanctions list. Costs 100 credits per company returned."},{"name":"Insights - Enumerations","description":"Reference lists used as search filters: entity types, the event taxonomy and languages. The taxonomy is a hierarchy of impact type › event category › event type and differs per entity type; `event_types_tree` returns the whole hierarchy for an entity type in one call. These calls are free."},{"name":"Insights - Search","description":"The news-based signals themselves.\n\n* **Summaries** are plain-language narratives of a real-world development over a period, with a sentiment from −2 to 2. Use them for briefings. 5 credits per summary returned.\n* **Events** are individual signals (entity + event type + time) with an intensity and article counts. Use them for timelines, counts and models. 1 credit per event returned.\n* **Supply chain** returns the supplier relations of an entity. 100 credits per relation returned, so start with `depth=1`.\n\nSearches require `date_from` and `date_to`. Page through results by sending the same body again with the `cursor` from the last response."}]}