Access API directly

To access the API directly, you may need to interact with Algolia’s PHP client. The Algolia PHP client lets you use Algolia’s features in the most customizable way possible.

Scout Extended already ships with version 4 of Algolia’s PHP client (algolia/algoliasearch-client-php), so you don’t need to require it separately.

`Algolia::client`

The client method returns an instance of Algolia\AlgoliaSearch\Api\SearchClient:

PHP

use Algolia\ScoutExtended\Facades\Algolia;

$client = Algolia::client();

$apiKeys = $client->listApiKeys();
$indices = $client->listIndices();
$client->operationIndex('indexNameSrc', [
    'operation' => 'copy',
    'destination' => 'indexNameDest',
]);
$client->operationIndex('indexNameSrc', [
    'operation' => 'move',
    'destination' => 'indexNameDest',
]);
// ...

`Algolia::index`

The index method returns the index name of the given searchable as a string. Pass it to the client’s index-scoped methods:

PHP

use Algolia\ScoutExtended\Facades\Algolia;

$client = Algolia::client();
$indexName = Algolia::index(App\Models\Article::class);

$synonym = $client->getSynonym($indexName, 'a-unique-identifier');
$rule = $client->getRule($indexName, 'a-unique-identifier');
$client->deleteIndex($indexName);
// ...

`Algolia::analytics`

The analytics method returns an instance of Algolia\AlgoliaSearch\Api\AnalyticsClient:

PHP

use Algolia\ScoutExtended\Facades\Algolia;

$analytics = Algolia::analytics();
$test = $analytics->getABTest(42); // The A/B test ID
// ...

Last modified on July 23, 2026

Zero downtime reimports

Multiple models in one index

Get started

Indexing

Searching

Production

Advanced use cases

Access API directly

`Algolia::client`

`Algolia::index`

`Algolia::analytics`

​Algolia::client

​Algolia::index

​Algolia::analytics

`Algolia::client`

`Algolia::index`

`Algolia::analytics`