Custom request

Required API Key:

Method signature

$client->custom(
  string $method,
  string $path,
  array $requestOptions,
  array $hosts
);

client.custom_request(
  data Hash,
  uri (String path),
  method (String method),
  call_type (String callType),
  request_options (dHash requestOptions),
)

client.customRequest<TResponse>(
  request: {
    method: string,
    path: string,
  },
  requestOptions: RequestOptions
);

client.custom_request(
  data dict,
  path (string path),
  method (string method),
  call_type (string callType),
  request_options (dict requestOptions),
)

client.customRequest<T: Decodable>(
  callType: CallType,
  request: URLRequest,
  requestOptions: RequestOptions? = nil,
  completion: @escaping ResultCallback<T>
) -> Operation

client.customRequest<T>(
  method: Method,
  callType: CallType,
  path: String,
  body: String?,
  requestOptions: RequestOptions?
)

client.CustomRequest<TResponse, TRequest>(
  TRequest data,
  string path,
  HttpMethod method,
  CallType callType,
  RequestOptions requestOptions
);

client.getTransport().executeRequestAsync(
  HttpMethod method,
  String path,
  CallType callType,
  TData data,
  Class<TResult> returnClass,
  RequestOptions requestOptions
)

client.CustomRequest(
  res interface{},
  method string,
  path string,
  body interface{},
  callType call.Kind,
  requestOptions ...interface{},
})

custom request CustomRequest(
  verb: HttpVerb,
  path: Seq[String],
  endpoint: RequestEndpoint,
  queryParameters: Option[Map[String, String]],
  body: Option[String],
  requestOptions: Option[RequestOptions]
)

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Perform a custom request

Perform a request from the given parameters and send it through the requester, making use of the underlying retry strategy.

Examples

Read the Algolia CLI documentation for more information.

Perform a custom request:

Copy

1
2
3
4
$res = $client->custom(
  'GET',
  api_path('/1/custom/endpoint')
);

1
2
3
4
5
6
7
8
9
10
from algoliasearch.helpers import endpoint
from algoliasearch.http.verb import Verb
from algoliasearch.http.hosts import CallType

res = client.custom_request(
  {},
  endpoint("/1/custom/endpoint/{}", "my_parameter"),
  Verb.GET,
  CallType.READ
)

1
2
3
4
5
6
var request = URLRequest(url: URL(string: "/customEndpoint")!)
request.httpMethod = "POST"
request.httpBody = try! JSONEncoder().encode(["k1": "v1", "k2": 2] as JSON)
client.customRequest(callType: .write, request: request, requestOptions: nil) { (result: Result<JSON, Swift.Error>) in
  print(result)
}

1
2
3
4
5
6
7
8
9
val response = client.customRequest<JsonElement>(
      method = HttpMethod.Post,
      callType = CallType.Write,
      path = "customEndpoint",
      body = buildJsonObject {
          put("k1", JsonPrimitive("v1"))
          put("k2", JsonPrimitive(2))
      }.toString()
  )

1
2
3
4
5
6
7
8
9
EndpointResponse response =
  client.CustomRequest<EndpointResponse, EndpointRequest>(
    new EndpointRequest {
      // parameters
    },
    "/1/custom/endpoint",
    System.Net.Http.HttpMethod.Get,
    Algolia.Search.Models.Enums.CallType.Read
  );

1
2
3
4
5
6
7
8
9
client
      .getTransport()
      .executeRequestAsync(
          HttpMethod.POST,
          "/customEndpoint",
          CallType.WRITE,
          Map.of("k1", "v1", "k2", 2),
          EndpointResponse.class,
          null);

1
2
3
4
5
6
custom request CustomRequest(
    verb = POST,
    path = Seq("my", "custom", "endpoint"),
    endpoint = RequestEndpoint.Search,
    body = Some("""{"k1": "v1", "k2": 2}""")
  )

Parameters

Parameter	Description
`path`	type: string Required The path of the API endpoint to call, as exposed in the documentation.
`method`	type: string Required REST HTTP method to send with the query, can be one of: `GET`, `POST`, `PUT`, `DELETE`.
`callType`	Required Indicate whether the HTTP call performed is of type [read] (GET) or [write] (POST, PUT ..). Used to determine which timeout duration to use.
`requestOptions`	type: list default: No requestOptions Optional A mapping of `requestOptions` to send along with the request.

Response

This method doesn't return a response.