Skip to main content

Request Configuration

Preview

Request configuration is a preview feature. It works as described below, but the option names and shapes may still change.

RevealSdkClient.initialize() accepts options that control the HTTP requests the client sends to your AI server. Configure them only when your application needs authentication or additional request headers.

Bearer-Token Authentication​

Use bearerToken when the token is already available at startup. The client sends it as an Authorization: Bearer <token> header on every request.

RevealSdkClient.initialize({
  hostUrl: 'https://your-server.com',
  bearerToken: 'your-token'
});

To replace that token later, for example after a refresh, call setBearerToken() on the client instance:

RevealSdkClient.getInstance().setBearerToken(newToken);

Use getBearerToken instead when the token must be resolved per request. The callback can be synchronous or asynchronous, and it is called before each request is sent, so your authentication provider can return or refresh the current token.

RevealSdkClient.initialize({
  hostUrl: 'https://your-server.com',
  getBearerToken: async () => {
    return await authService.getValidAccessToken();
  }
});

Use either the static token or the callback, not both.

Custom Request Headers​

Use onRequest when you need to add or modify headers other than the bearer token. The interceptor receives the outgoing request, can be asynchronous, and is called before each request is sent.

RevealSdkClient.initialize({
  hostUrl: 'https://your-server.com',
  onRequest: async (request) => ({
    ...request,
    headers: {
      ...request.headers,
      'X-Tenant-Id': await tenantService.getCurrentTenantId()
    }
  })
});

Streaming Requests​

Bearer tokens and onRequest also apply to streaming requests. They are resolved once, when the Server-Sent Events (SSE) connection is opened, and not for each streamed event.

Response and Error Interceptors​

initialize() also accepts an onResponse interceptor, called with the raw Response of each completed request, and an onError interceptor, called with the error of each failed request. Both can be asynchronous, and both return the value the client continues with, so onError can enrich an error but cannot suppress it.

For handling AI errors in application code, see Error Handling.