feat(chat): add request options to agent requests

[anjola-adeuyi]

Summary

FX-3833

Adds requestOptions for built-in agentId chat requests so consumers can pass persistent query parameters and headers to Agent Studio completion requests.

This is scoped to the built-in Agent Studio path only:

• supports queryParameters
• supports headers
• rejects requestOptions with custom transport or custom chat
• keeps body, metadata, resume/reconnect and custom transport behavior out of scope

Regenerate still forces cache=false.

Documentation

FX-3833 also includes a documentation update. The documentation source lives in algolia/docs-new, so this InstantSearch PR keeps the implementation scoped and the docs-new follow-up should verify/update the generated chat widget API docs for requestOptions.

Test plan

• Focused connector tests for persistent query parameters
• Focused connector tests for object headers and Headers
• Per-call headers override persistent headers for one request
• Regenerate keeps cache=false
• yarn jest packages/instantsearch.js/src/connectors/chat/__tests__/connectChat-test.ts --runInBand
• Prettier check
• git diff --check
• yarn lint:changed

[codacy-production]

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

_{TIP This summary will be updated as you push new changes.}

[pkg-pr-new]

More templates

• example-instantsearch-getting-started
• example-react-instantsearch-getting-started
• example-react-instantsearch-next-app-dir-example
• example-react-instantsearch-next-routing-example
• example-vue-instantsearch-getting-started

algoliasearch-helper

npm i https://pkg.pr.new/algolia/instantsearch/algoliasearch-helper@7088

instantsearch-ui-components

npm i https://pkg.pr.new/algolia/instantsearch/instantsearch-ui-components@7088

instantsearch.css

npm i https://pkg.pr.new/algolia/instantsearch/instantsearch.css@7088

instantsearch.js

npm i https://pkg.pr.new/algolia/instantsearch/instantsearch.js@7088

react-instantsearch

npm i https://pkg.pr.new/algolia/instantsearch/react-instantsearch@7088

react-instantsearch-core

npm i https://pkg.pr.new/algolia/instantsearch/react-instantsearch-core@7088

react-instantsearch-nextjs

npm i https://pkg.pr.new/algolia/instantsearch/react-instantsearch-nextjs@7088

react-instantsearch-router-nextjs

npm i https://pkg.pr.new/algolia/instantsearch/react-instantsearch-router-nextjs@7088

vue-instantsearch

npm i https://pkg.pr.new/algolia/instantsearch/vue-instantsearch@7088

commit: 603556f

[Copilot]

Pull request overview

Adds support for passing persistent request options (query parameters + headers) to the built-in Agent Studio (agentId) chat completion requests, while keeping custom transport/custom chat paths out of scope and ensuring regenerate continues to bypass cache.

Changes:

• Introduces requestOptions typing restricted to the built-in agentId transport path (rejects with custom transport or custom chat).
• Builds Agent Studio completion URLs with persistent query parameters and enforces compatibilityMode=ai-sdk-5 (and cache=false on regenerate).
• Merges persistent headers into agent requests while preserving required Algolia identity headers.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
packages/instantsearch.js/src/connectors/chat/connectChat.ts	Adds requestOptions types and applies persistent query parameters/headers to built-in agent requests.
packages/instantsearch.js/src/connectors/chat/__tests__/connectChat-test.ts	Adds type-level and runtime tests for requestOptions behavior (query params, headers, precedence, regenerate cache).

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Haroenv]

great job! I think it can be simplified a bit

[Haroenv]

couple small questions

[Haroenv]

LGTM! merge when you're ready :)