Jan 20, 2025
Request options
The API client methods accept additional parameters for adding headers or query parameters.
To customize all requests, you can customize the client.
For example:
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?php
require_once realpath(__DIR__.'/vendor/autoload.php');
use Algolia\AlgoliaSearch\Api\SearchClient;
$client = SearchClient::create(
appId: 'ALGOLIA_APPLICATION_ID',
apiKey: 'ALGOLIA_API_KEY',
);
$requestOptions = [
// Add custom HTTP header to this request
'headers' => ['extra-header' => 'greetings'],
// Add query parameter to this request
'queryParameters' => ['queryParam' => 'value'],
];
$client->searchSingleIndex(
indexName: 'ALGOLIA_INDEX_NAME',
searchParams: ['query' => 'time'],
requestOptions: $requestOptions,
);
Reference
headers
|
type: array<string,string>
Additional headers as key-value pairs to send with this request.
To add a header, use the |
queryParameters
|
type: array<string,any>
Additional query parameters to send with this request.
They only take effect with API operations that support query parameters.
Otherwise, they’re ignored.
To add query parameters to this request, use the |
Did you find this page helpful?