Skip to content

emergentmethods/asknews-php-sdk

BranchesTags

Repository files navigation

asknews-php-sdk

AskNews API

Installation & Usage

Requirements

PHP 8.0 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/emergentmethods/asknews-php-sdk.git"
    }
  ],
  "require": {
    "emergentmethods/asknews-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/asknews-php-sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




// Configure sdk credentials
$config = new AskNews\Configuration([
  'clientId' => 'YOUR_ASKNEWS_CLIENT_ID',
  'clientSecret' => 'YOUR_ASKNEWS_CLIENT_SECRET',
  'scopes' => ['news', 'chat', 'stories', 'analytics']
]);


$apiInstance = new AskNews\Api\AlertsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_alert_request = new \AskNews\Model\CreateAlertRequest(); // \AskNews\Model\CreateAlertRequest

try {
    $result = $apiInstance->createAlert($create_alert_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->createAlert: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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 putAlert PUT /v1/chat/alerts/{alert_id} Update an 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
ChatApi getChatCompletions POST /v1/openai/chat/completions Get chat completions from a news-infused AI assistant
ChatApi getHeadlineQuestions GET /v1/chat/questions Get example headline questions
ChatApi listChatModels GET /v1/openai/models List available chat models
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
NewsApi getArticle GET /v1/news/{article_id} Get an article by its UUID
NewsApi getArticles GET /v1/news Get multiple articles by UUID
NewsApi getSourcesReport GET /v1/sources Get the sources underlying AskNews
NewsApi searchNews GET /v1/news/search Search for enriched real-time news context
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.

Models

Authorization

  • Type: OAuth
  • Flow: client_credentials
  • Authorization URL: https://auth.asknews.app/oauth2/auth
  • Scopes:
    • chat: Chat related operations
    • news: News related operations
    • analytics: Analytics related operations
    • stories: Stories related operations
    • profile: Profile related operations
    • reddit: Reddit related operations

Find full details at the AskNews API documentation.

Support

Join our Discord to see what other people are building, and to get support with your projects.

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

30 tags

Packages

No packages published

Languages