We use cookies to ensure you get the best experience on our website. Some of these cookies are provided by third parties. You are free to decide which categories you would like to permit and can withdraw this consent at any time (via cookie preferences link on the footer).
By accepting the necessary cookies, you agree to our privacy policy and terms of service, both located in the footer of the website.
Learn more on our terms of service and privacy policy.
Complete reference for the AskNews API (version 0.30.0), covering every customer-facing endpoint.
GET /v1/chat/alertsGet all created alerts
Get all created alerts.
POST /v1/chat/alertsCreate an alert
Create an alert.
GET /v1/chat/alerts/{alert_id}Get an alert
Get an alert.
PUT /v1/chat/alerts/{alert_id}Update an alert
Update an alert.
DELETE /v1/chat/alerts/{alert_id}Delete an alert
Delete an alert.
GET /v1/chat/alerts/{alert_id}/logsGet alert logs
Get alert logs.
GET /v1/chat/alerts/{alert_id}/runRun an existing alert
Get an alert.
GET /v1/chat/alerts/logsGet all alert logs
Get all alert logs.
GET /v1/analytics/finance/sentimentGet a timeseries of finance news sentiment for assets
Get the news sentiment for a given asset during a provided period of time.
GET /v1/chat/autofilterGenerate filter params for AskNews endpoints
This is a helper endpoint designed to intelligently populate the "parameters of the /news search endpoint of AskNews. It takes a description of the type of news that you want to access, and then maps it to the available parameters automatically.
GET /v1/byok/{provider}Get a stored BYOK API key hint for a provider
Get the stored BYOK API key hint for a provider. Bring your own key is reserved for enterprise clients. If you want to use this feature, please contact us at contact@asknews.app
PUT /v1/byok/{provider}Store a BYOK API key for a provider
Store a BYOK API key for a provider. Bring your own key is reserved for enterprise clients. If you want to use this feature, please contact us at contact@asknews.app
DELETE /v1/byok/{provider}Delete a stored BYOK API key for a provider
Delete a stored BYOK API key for a provider. Bring your own key is reserved for enterprise clients. If you want to use this feature, please contact us at contact@asknews.app
POST /v1/chat/chartsCreate a chart
Create charts.
POST /v1/chat/deepnewsDeep research into real-time news, archive news, and Google.
GET /v1/chat/deepnews-modelsList available DeepNews models
List the available DeepNews models with their public type (standard/lite/advanced).
POST /v1/openai/chat/completionsGet chat completions from a news-infused AI assistant
Get the chat completions for a given user message. This endpoint follows the OpenAI API spec. It includes a couple extra params, which include:
GET /v1/distribution/articles/domain_hits_surfaceGet total hits and surfaced articles for domains
Get total hits and surfaced articles for domains.
GET /v1/distribution/articles/domain_hits_surface_timewindowGet hits and surfaced articles per day for domains
Get hits and surfaced articles per day for domains.
GET /v1/distribution/articles/domain_queriesGet queries that surfaced domain articles
Get article hits.
GET /v1/distribution/articles/top_nGet the top N articles by hits
Get the top N articles by hits.
GET /v1/distribution/articles/top_n_for_domain_timeseriesGet the top N articles by hits for domain with daily breakdown
Get the top N domain articles by hits with daily breakdown.
GET /v1/distribution/articles/top_n_for_domainsGet the top N articles by hits for domains
Get the top N domain articles by hits.
GET /v1/distribution/domainsFind domains
Find domains with optional filters.
GET /v1/distribution/domains/{name}Get a domain by name
Get a domain.
GET /v1/distribution/domains/top_nGet the top N domains by hits
Get the top N domains by hits.
GET /v1/distribution/stats/countGet article hits
Get the number of hits for articles in a specific domain.
GET /v1/distribution/stats/hit_shareGet the hit share for a list of domains in a time period
Get the hit share for a list of domains in a time period.
GET /v1/distribution/stats/metricsGet raw publisher metric event counts for domains
Get raw (unweighted) surface, citation, full_text and grounded publisher metric event counts for a list of domains in a time period. Counts are 1 per real event; revenue-share weighting stays in the distribution service.
GET /v1/distribution/stats/metrics_timeseriesGet raw publisher metric event counts per day for domains
Get raw (unweighted) surface, citation, full_text and grounded publisher metric event counts per day for a list of domains in a time period.
GET /v1/chat/forecastMake an expert forecast for a news event.
Make an expert forecast for a news event.
POST /v1/news/graphBuild a custom mega-news-knowledge graph
Explore our mega-news-knowledge-graph at which ever level of resolution you need.
POST /v1/news/index_urlsIndex a list of URLs into AskNews
Index a list of news article URLs.
GET /v1/index_countsGet the index counts underlying AskNews
This endpoint is primarly used for the publisher dashboard, to show the number of articles indexed per source.
GET /v1/newsGet multiple articles by UUID
Get articles given a list of UUIDs.
GET /v1/news/{article_id}Get an article by its UUID
Get a single article given a UUID.
GET /v1/news/searchSearch for enriched real-time news context
Search for any news, up to the last 5 minutes or in our extensive historical archive filled with 100s of millions of articles.
GET /v1/sourcesGet the sources underlying AskNews
This endpoint is primarly used for transparency and monitoring the diversity of the data.
GET /v1/chat/newslettersGet all created newsletters
Get all created newsletters.
POST /v1/chat/newslettersCreate a newsletter
Create a newsletter.
GET /v1/chat/newsletters/{newsletter_id}Get a newsletter
Get a newsletter.
PUT /v1/chat/newsletters/{newsletter_id}Update a newsletter
Update a newsletter.
DELETE /v1/chat/newsletters/{newsletter_id}Delete a newsletter
Delete a newsletter.
GET /v1/chat/newsletters/{newsletter_id}/contactsGet newsletter contacts
Get newsletter contacts.
POST /v1/chat/newsletters/{newsletter_id}/contactsCreate a newsletter contact
Create a newsletter contact.
GET /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id}Get a newsletter contact
Get a newsletter contact.
PATCH /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id}Update a newsletter contact
Update a newsletter contact.
DELETE /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id}Delete a newsletter contact
Delete a newsletter contact.
POST /v1/chat/newsletters/{newsletter_id}/unsubscribeUnsubscribe from a newsletter
Unsubscribe from a newsletter.
GET /v1/chat/newsletters/publicGet all public newsletters
Get all public newsletters.
GET /Ping
GET /v1/profiles/meGet the current user's profile
Get the current profile
GET /v1/profiles/me/limitsGet the current user's rate limit status
Return the caller's current rate-limit and concurrency-limit state without consuming any tokens.
GET /v1/reddit/searchSearch Reddit, summarize threads, and return analysis.
Go to Reddit, search threads, summarize the threads, return analysis. `deep`=True is a live web scrape, AskNews searches Reddit, finds threads, summarizes them, analyzes them, and returns the results. `deep`=False is a search in AskNews' existing database of Reddit threads.
GET /v1/storiesFilter and search for top news narratives
Filter on our custom, in-house written, stories/events/narratives.
GET /v1/stories/{story_id}Get a story containing updates
Get a single news story given its UUID.
GET /v1/chat/websearchRun a live websearch.
Run a live websearch on a set of queries, get back a fully structured and LLM-distilled response (in addition to the raw text if you need that as well).
GET /v1/wiki/searchSearch for Wikipedia context with natural language
Search on Wikipedia content with natural language. Find exactly relevant chunks, with contextual neighbor chunks, and the full articles they came from.