CopilotKit.mdx

title	<CopilotKit />
description	Provides the Copilot context to its children.

{/* GENERATE-DOCS path=packages/react-core/src/components/copilot-provider/copilotkit.tsx component=CopilotKit */}

This component provides the Copilot context to its children. It can be configured either with a chat API endpoint or a CopilotApiConfig.

The backend can use OpenAI, or you can bring your own LLM. For examples of the backend api implementation, see `examples/next-openai` or the [runtime docs](https://docs.copilotkit.ai/getting-started/quickstart-runtime). ```jsx CopilotKit Example import { CopilotKit } from "@copilotkit/react-core";

</RequestExample>

## Example usage

```jsx
<CopilotKit publicApiKey="the api key or self host (see below)">
<App />
</CopilotKit>

Props

Your Copilot Cloud API key. Cloud feature: Restrict input to a specific topic. the endpoint for the Copilot Runtime instance. The endpoint for the Copilot transcribe audio service. The endpoint for the Copilot text to speech service. Additional headers to be sent with the request.

For example:

{
  'Authorization': 'Bearer your_token_here'
}

Additional body params to be sent with the request For example: ```js { 'message': 'Hello, world!' } ``` The children to be rendered within the CopilotKit. Custom properties to be sent with the request For example: ```js { 'user_id': 'users_id', } ``` Indicates whether the user agent should send or receive cookies from the other domain in the case of cross-origin requests.