AskNews API
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 0.24.22
- Package version: 0.4.18
- Generator version: 7.12.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/net/contextPut the package under your project folder and add the following in import:
import asknews "github.com/emergentmethods/asknews-go-sdk"To use a proxy, set the environment variable HTTP_PROXY:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.
For using other server than the one defined on index 0 set context value asknews.ContextServerIndex of type int.
ctx := context.WithValue(context.Background(), asknews.ContextServerIndex, 1)Templated server URL is formatted using default variables from configuration or from context value asknews.ContextServerVariables of type map[string]string.
ctx := context.WithValue(context.Background(), asknews.ContextServerVariables, map[string]string{
"basePath": "v2",
})Note, enum values are always validated and all unused variables are silently ignored.
Each operation can use different server URL defined using OperationServers map in the Configuration.
An operation is uniquely identified by "{classname}Service.{nickname}" string.
Similar rules for overriding default operation server index and variables applies by using asknews.ContextOperationServerIndices and asknews.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), asknews.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), asknews.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})All URIs are relative to https://api.asknews.app
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AlertsAPI | CreateAlert | Post /v1/chat/alerts | Create an alert |
| AlertsAPI | DeleteAlert | Delete /v1/chat/alerts/{alert_id} | Delete an alert |
| AlertsAPI | GetAlert | Get /v1/chat/alerts/{alert_id} | Get an alert |
| AlertsAPI | GetAlertLogs | Get /v1/chat/alerts/{alert_id}/logs | Get alert logs |
| AlertsAPI | GetAlerts | Get /v1/chat/alerts | Get all created alerts |
| AlertsAPI | GetAllAlertLogs | Get /v1/chat/alerts/logs | Get all alert logs |
| AlertsAPI | PutAlert | Put /v1/chat/alerts/{alert_id} | Update an alert |
| AlertsAPI | RunAlert | Get /v1/chat/alerts/{alert_id}/run | Run an existing alert |
| AnalyticsAPI | GetAssetSentiment | Get /v1/analytics/finance/sentiment | Get a timeseries of finance news sentiment for assets |
| AutofilterAPI | Autofilter | Get /v1/chat/autofilter | Generate filter params for AskNews endpoints |
| ChartsAPI | CreateChartsEndpoint | Post /v1/chat/charts | Create a chart |
| ChatAPI | DeepNews | Post /v1/chat/deepnews | Deep research into real-time news, archive news, and Google. |
| ChatAPI | GetChatCompletions | Post /v1/openai/chat/completions | Get chat completions from a news-infused AI assistant |
| ChatAPI | ListDeepnewsModels | Get /v1/chat/deepnews-models | List available DeepNews models |
| DistributionAPI | DomainHitShare | Get /v1/distribution/stats/hit_share | Get the hit share for a list of domains in a time period |
| DistributionAPI | FindDomains | Get /v1/distribution/domains | Find domains |
| DistributionAPI | GetArticleHits | Get /v1/distribution/stats/count | Get article hits |
| DistributionAPI | GetDomain | Get /v1/distribution/domains/{name} | Get a domain by name |
| DistributionAPI | GetDomainHitsSurface | Get /v1/distribution/articles/domain_hits_surface | Get total hits and surfaced articles for domains |
| DistributionAPI | GetDomainHitsSurfaceTimewindow | Get /v1/distribution/articles/domain_hits_surface_timewindow | Get hits and surfaced articles per day for domains |
| DistributionAPI | GetDomainQueries | Get /v1/distribution/articles/domain_queries | Get queries that surfaced domain articles |
| DistributionAPI | TopNArticlesByHits | Get /v1/distribution/articles/top_n | Get the top N articles by hits |
| DistributionAPI | TopNArticlesForDomainTimeseries | Get /v1/distribution/articles/top_n_for_domain_timeseries | Get the top N articles by hits for domain with daily breakdown |
| DistributionAPI | TopNArticlesForDomains | Get /v1/distribution/articles/top_n_for_domains | Get the top N articles by hits for domains |
| DistributionAPI | TopNDomainsByHits | Get /v1/distribution/domains/top_n | Get the top N domains by hits |
| DistributionAPI | UpdateDomain | Put /v1/distribution/domains/{name} | Update an existing domain |
| ForecastAPI | GetForecast | Get /v1/chat/forecast | Make an expert forecast for a news event. |
| GraphAPI | BuildGraph | Post /v1/news/graph | Build a custom mega-news-knowledge graph |
| IndexUrlsAPI | IndexUrls | Post /v1/news/index_urls | Index a list of URLs into AskNews |
| NewsAPI | GetArticle | Get /v1/news/{article_id} | Get an article by its UUID |
| NewsAPI | GetArticles | Get /v1/news | Get multiple articles by UUID |
| NewsAPI | GetIndexCounts | Get /v1/index_counts | Get the index counts underlying AskNews |
| NewsAPI | GetSourcesReport | Get /v1/sources | Get the sources underlying AskNews |
| NewsAPI | SearchNews | Get /v1/news/search | Search for enriched real-time news context |
| NewslettersAPI | DeleteNewsletter | Delete /v1/chat/newsletters/{newsletter_id} | Delete a newsletter |
| NewslettersAPI | DeleteNewsletterContact | Delete /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id} | Delete a newsletter contact |
| NewslettersAPI | GetNewsletter | Get /v1/chat/newsletters/{newsletter_id} | Get a newsletter |
| NewslettersAPI | GetNewsletterContact | Get /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id} | Get a newsletter contact |
| NewslettersAPI | GetNewsletterContacts | Get /v1/chat/newsletters/{newsletter_id}/contacts | Get newsletter contacts |
| NewslettersAPI | GetNewsletters | Get /v1/chat/newsletters | Get all created newsletters |
| NewslettersAPI | GetPublicNewsletters | Get /v1/chat/newsletters/public | Get all public newsletters |
| NewslettersAPI | PatchNewsletterContact | Patch /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id} | Update a newsletter contact |
| NewslettersAPI | PostNewsletter | Post /v1/chat/newsletters | Create a newsletter |
| NewslettersAPI | PostNewsletterContacts | Post /v1/chat/newsletters/{newsletter_id}/contacts | Create a newsletter contact |
| NewslettersAPI | PutNewsletter | Put /v1/chat/newsletters/{newsletter_id} | Update a newsletter |
| NewslettersAPI | UnsubscribeNewsletter | Post /v1/chat/newsletters/{newsletter_id}/unsubscribe | Unsubscribe from a newsletter |
| PingAPI | Ping | Get / | Ping |
| ProfileAPI | GetUserProfile | Get /v1/profiles/me | Get the current user's profile |
| RedditAPI | SearchReddit | Get /v1/reddit/search | Search Reddit, summarize threads, and return analysis. |
| StoriesAPI | GetStories | Get /v1/stories | Filter and search for top news narratives |
| StoriesAPI | GetStory | Get /v1/stories/{story_id} | Get a story containing updates |
| WebsearchAPI | LiveWebSearch | Get /v1/chat/websearch | Run a live websearch. |
| WikiAPI | SearchWiki | Get /v1/wiki/search | Search for Wikipedia context with natural language |
- AbcAPIErrorModel1
- AbcAPIErrorModel10
- AbcAPIErrorModel100
- AbcAPIErrorModel101
- AbcAPIErrorModel102
- AbcAPIErrorModel103
- AbcAPIErrorModel104
- AbcAPIErrorModel105
- AbcAPIErrorModel106
- AbcAPIErrorModel107
- AbcAPIErrorModel108
- AbcAPIErrorModel11
- AbcAPIErrorModel12
- AbcAPIErrorModel13
- AbcAPIErrorModel14
- AbcAPIErrorModel15
- AbcAPIErrorModel16
- AbcAPIErrorModel17
- AbcAPIErrorModel18
- AbcAPIErrorModel19
- AbcAPIErrorModel2
- AbcAPIErrorModel20
- AbcAPIErrorModel21
- AbcAPIErrorModel22
- AbcAPIErrorModel23
- AbcAPIErrorModel24
- AbcAPIErrorModel25
- AbcAPIErrorModel26
- AbcAPIErrorModel27
- AbcAPIErrorModel28
- AbcAPIErrorModel29
- AbcAPIErrorModel3
- AbcAPIErrorModel30
- AbcAPIErrorModel31
- AbcAPIErrorModel32
- AbcAPIErrorModel33
- AbcAPIErrorModel34
- AbcAPIErrorModel35
- AbcAPIErrorModel36
- AbcAPIErrorModel37
- AbcAPIErrorModel38
- AbcAPIErrorModel39
- AbcAPIErrorModel4
- AbcAPIErrorModel40
- AbcAPIErrorModel41
- AbcAPIErrorModel42
- AbcAPIErrorModel43
- AbcAPIErrorModel44
- AbcAPIErrorModel45
- AbcAPIErrorModel46
- AbcAPIErrorModel47
- AbcAPIErrorModel48
- AbcAPIErrorModel49
- AbcAPIErrorModel5
- AbcAPIErrorModel50
- AbcAPIErrorModel51
- AbcAPIErrorModel52
- AbcAPIErrorModel53
- AbcAPIErrorModel54
- AbcAPIErrorModel55
- AbcAPIErrorModel56
- AbcAPIErrorModel57
- AbcAPIErrorModel58
- AbcAPIErrorModel59
- AbcAPIErrorModel6
- AbcAPIErrorModel60
- AbcAPIErrorModel61
- AbcAPIErrorModel62
- AbcAPIErrorModel63
- AbcAPIErrorModel64
- AbcAPIErrorModel65
- AbcAPIErrorModel66
- AbcAPIErrorModel67
- AbcAPIErrorModel68
- AbcAPIErrorModel69
- AbcAPIErrorModel7
- AbcAPIErrorModel70
- AbcAPIErrorModel71
- AbcAPIErrorModel72
- AbcAPIErrorModel73
- AbcAPIErrorModel74
- AbcAPIErrorModel75
- AbcAPIErrorModel76
- AbcAPIErrorModel77
- AbcAPIErrorModel78
- AbcAPIErrorModel79
- AbcAPIErrorModel8
- AbcAPIErrorModel80
- AbcAPIErrorModel81
- AbcAPIErrorModel82
- AbcAPIErrorModel83
- AbcAPIErrorModel84
- AbcAPIErrorModel85
- AbcAPIErrorModel86
- AbcAPIErrorModel87
- AbcAPIErrorModel88
- AbcAPIErrorModel89
- AbcAPIErrorModel9
- AbcAPIErrorModel90
- AbcAPIErrorModel91
- AbcAPIErrorModel92
- AbcAPIErrorModel93
- AbcAPIErrorModel94
- AbcAPIErrorModel95
- AbcAPIErrorModel96
- AbcAPIErrorModel97
- AbcAPIErrorModel98
- AbcAPIErrorModel99
- AlertLog
- AlertResponse
- Article
- AskNewsSource
- AsknewsApiErrorsAPIErrorModel
- AsknewsApiSchemaV1CommonGraphRelationships
- AsknewsApiSchemaV1StoriesGraphRelationships
- Assets
- Assets1
- Author
- Author1
- BadDomainUrl
- BadDomainUrl1
- BadDomainUrl2
- BlueskySource
- BlueskySourceParams
- BodyBuildGraph
- ChartParameters
- ChartResponse
- Choice
- CirrusMetadata
- Classification
- ClusterProbabilitiesValue
- Continent
- CountResponse
- CreateAlertRequest
- CreateChartRequest
- CreateChatCompletionRequest
- CreateChatCompletionRequestMessage
- CreateChatCompletionRequestMessage1
- CreateChatCompletionResponse
- CreateChatCompletionResponse1
- CreateChatCompletionResponseChoice
- CreateChatCompletionResponseChoice1
- CreateChatCompletionResponseStream
- CreateChatCompletionResponseStream1
- CreateChatCompletionResponseStreamChoice
- CreateChatCompletionResponseStreamChoice1
- CreateChatCompletionResponseUsage
- CreateChatCompletionResponseUsage1
- CreateDeepNewsRequest
- CreateDeepNewsRequestMessage
- CreateDeepNewsRequestMessage1
- CreateDeepNewsRequestModel
- CreateDeepNewsResponse
- CreateDeepNewsResponse1
- CreateDeepNewsResponseChoice
- CreateDeepNewsResponseChoice1
- CreateDeepNewsResponseStreamChunk
- CreateDeepNewsResponseStreamChunk1
- CreateDeepNewsResponseStreamChunkChoice
- CreateDeepNewsResponseStreamChunkChoice1
- CreateDeepNewsResponseStreamSource
- CreateDeepNewsResponseStreamSourcesChartSource
- CreateDeepNewsResponseStreamSourcesGraphSource
- CreateDeepNewsResponseStreamSourcesNewsSource
- CreateDeepNewsResponseStreamSourcesWebSource
- CreateDeepNewsResponseUsage
- CreateDeepNewsResponseUsage1
- CreateNewsletterRequest
- DeepNewsModel
- DeepNewsModelItem
- DeepNewsReportParams
- DeepNewsReportRequest
- DeepNewsResponseSources
- DeepNewsResponseSources1
- DeepNewsSource
- DeepNewsSourceParams
- DisplayImageUrl
- DomainHitsSurfaceDayItem
- DomainHitsSurfaceResponse
- DomainHitsSurfaceTimeWindowResponse
- DomainQueriesResponse
- DomainQueryArticleItem
- DomainQueryClusterItem
- DomainQueryItem
- DomainUrl
- DomainUrl1
- EmailAction
- EmailParams
- Entities
- Entities1
- FilterParams
- FilterParams1
- FilterParamsMetadata
- FilterParamsResponse
- FinanceResponse
- FinanceResponseTimeSeries
- FinanceResponseTimeSeriesData
- ForecastResponse
- GeoCoordinate
- GeoCoordinate1
- GoogleDocsAction
- GoogleDocsParams
- GraphRelationships
- GraphResponse
- HTTPValidationError
- HitShareItem
- HitShareResponse
- IndexCountItem
- IndexUrlsResponse
- IntraClusterStatistics
- KeyPerson
- LegacyReportRequest
- ListDeepNewsModelResponse
- MCPFilterParams
- NewsletterContactCreateResponse
- NewsletterContactRequest
- NewsletterContactResponse
- NewsletterContactUpdateResponse
- NewsletterPublicResponse
- NewsletterResponse
- Offset
- Offset1
- Offset2
- Offset3
- Offset4
- Offset5
- OrganizationProfile
- OrganizationProfileSubscription
- PaginatedResponseAlertLog
- PaginatedResponseAlertResponse
- PaginatedResponseNewsletterPublicResponse
- PaginatedResponseNewsletterResponse
- PaginatedResponseReadDomainResponse
- PingModel
- Profile
- ProfileResponse
- ReadDomainResponse
- RedditComment
- RedditEntities
- RedditPerspective
- RedditResponse
- RedditThread
- ReferralItem
- ReplyTo
- Report
- Report1
- Report1AnyOf
- Report2
- Report2AnyOfInner
- ReportingVoice
- ReportingVoice1
- ReportingVoice2
- ResendBroadcastAction
- ResendBroadcastParams
- ScrapeDataItem
- ScrapeItem
- ScrapedURLItem
- SearchResponse
- SearchResponseDictItem
- SearchResponseDictItem1
- Sentiment
- SeriesConfig
- Source
- SourceReportItem
- Sources1
- Sources2
- SourcesInner
- Stop
- Stop1
- StoriesResponse
- StoryResponse
- StoryUpdate
- StoryUpdateDisplayImageUrlsInner
- TelegramSource
- TelegramSourceParams
- ThreadId
- ThreadId1
- TopNArticlesByHitsItem
- TopNArticlesByHitsResponse
- TopNArticlesForDomainItem
- TopNArticlesForDomainResponse
- TopNArticlesTimeseriesDayItem
- TopNArticlesTimeseriesItem
- TopNArticlesTimeseriesResponse
- TopNDomainsByHitsItem
- TopNDomainsByHitsResponse
- TriggersInner
- URLIndexingRequest
- UpdateAlertRequest
- UpdateDomainRequest
- UpdateNewsletterRequest
- User
- User1
- UserProfile
- UserProfileOrganization
- UserProfileSubscription
- ValidationError
- ValidationErrorItem
- ValidationErrorLocInner
- ValidationErrorModel
- Value
- WebSearchResponse
- WebSearchResult
- WebSearchResult1
- WebSource
- WebSourceParams
- WebhookAction
- WebhookParams
- WikiResponseDictItem
- WikiSearchResponse
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Note, each API key must be added to a map of map[string]APIKey where the key is: APIKey and passed in as the auth context for each request.
Example
auth := context.WithValue(
context.Background(),
asknews.ContextAPIKeys,
map[string]asknews.APIKey{
"APIKey": {Key: "API_KEY_STRING"},
},
)
r, err := client.Service.Operation(auth, args)Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime