API clients / Ruby

Customize your Ruby client

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

To change individual requests made with an API client, pass individual Request options. To change all requests, create a custom configuration. This lets you change timeouts, add HTTP headers, and so on.

Use a custom host

You can change the default hosts to which the API client connects:

Copy 
1
2
3
4
5
6
7
8
9
10
11

require 'algolia'

client = Algolia::Search::Client.new(
  Algolia::Search::Config.new({
    application_id: 'YourApplicationID',
    api_key: 'YourAPIKey',
    custom_hosts: [
        'yourdomain.com'
    ]
  })
)

Changing the hosts can be useful if you want to proxy the search requests through another server, for example, to process the request or response, or to perform custom analytics.

Add HTTP headers to every request

Adding HTTP headers to your requests lets you set parameters such as a user identifier or an IP address. This can be useful for analytics, geographical search, or applying API key rate limits.

Copy 
1
2

config = Algolia::Search::Config.create('YourApplicationID', 'YourWriteAPIKey')
config.headers['NAME-OF-HEADER'] = 'value-of-header'

You can add these headers to your requests:

Header Use case
X-Algolia-UserToken Use API key rate limits
X-Algolia-UserToken The Analytics API uses the value of this header to distinguish between users. It takes priority over any value in X-Forwarded-For. Use the X-Algolia-UserToken header to forward the user’s identity without relying on IP addresses.
X-Forwarded-For Use for analytics in backend implementations. If your server sends the user’s IP address with every search, analytics can distinguish between users. Otherwise, the analytics uses the server’s IP address and considers all your users as a single user.
X-Forwarded-For Use for geolocation, when you perform searches from your backend. This ensures that the geolocation for a search uses your user’s IP address and not that of your server.
Copy 
1
2
3
4
5
6
7

index = client.init_index('indexName')

request_options = {
      'X-Algolia-UserToken': 'user123'
}

res = index.search('query string', request_options)

Make sure to use the same user token for your events (Insights API) and search requests (Search API).

  • If you send the authenticatedUserToken with your events, send the same value with your search requests.
  • If you send the userToken with your events, send the same value with your search requests.

Change timeouts for all requests

Network connections and DNS resolution can be slow. That’s why the API clients come with default timeouts.

Copy 
1
2
3
4
5
6
7
8
9

config = Algolia::Search::Config.new({
   application_id: 'YourApplicationID',
   api_key: 'YourWriteAPIKey',
   read_timeout: 5, # read timeout in seconds
   write_timeout: 30, # write timeout in seconds
   connect_timeout: 2 # connect timeout in seconds
 })

client = Algolia::Search::Client.create_with_config(config)

Don’t change the default timeouts without a good reason.

Copy 
1
2
3
4
5
6
7
8

index = client.init_index('indexName')

request_options = {
  # Set the read_timeout to 20 seconds
      'read_timeout': 20
}

res = index.search('query string', request_options)
Did you find this page helpful?