API clients / JavaScript

Request options

The API client methods accept additional parameters for adding headers or query parameters.

If you want to customize the client itself, see Customize clients.

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

import { algoliasearch } from "algoliasearch";

const client = algoliasearch("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

await client.searchSingleIndex(
  {
    indexName,
    searchParams: {
      query: "SEARCH_QUERY",
    },
  },
  {
    // Add a custom HTTP header to this request
    headers: {
      "extra-header": "greetings",
    },
    // Add query parameters to this request
    queryParameters: {
      queryParam: "value",
    },
  },
);

Query parameters only apply to methods that accept them, such as GET requests. See the API reference for more information.

Reference

headers
type: Record<string, string>

Additional headers as key-value pairs to send with this request.
queryParameters
type: Record<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.
Did you find this page helpful?
JavaScript API clients v5