Back to Copilotkit

CopilotKit VNext Documentation

examples/v2/docs/introduction.mdx

1.57.01.8 KB
Original Source

API Reference

Core

<Card title="CopilotKitCore" icon="code" href="/reference/copilotkit-core"> Core CopilotKit class </Card> <Card title="CopilotRuntime" icon="server" href="/reference/copilot-runtime"> Host agents and expose runtime endpoints </Card>

<Card title="ProxiedCopilotRuntimeAgent" icon="server" href="/reference/proxied-copilot-runtime-agent"

Proxied runtime agent for CopilotKit </Card>

<Card title="FrontendTool" icon="wrench" href="/reference/frontend-tool"> Frontend tool utilities </Card>

React

Providers

<Card title="CopilotKitProvider" icon="layer-group" href="/reference/copilotkit-provider"

Main provider for CopilotKit React integration </Card>

<Card title="CopilotChatConfigurationProvider" icon="cog" href="/reference/copilot-chat-configuration-provider"

Configuration provider for CopilotChat </Card>

Components

<Card title="CopilotChat" icon="comments" href="/reference/copilot-chat"> Chat component for CopilotKit </Card>

Hooks

<Card title="useCopilotKit" icon="link" href="/reference/use-copilotkit"> Main hook for CopilotKit functionality </Card> <Card title="useAgent" icon="robot" href="/reference/use-agent"> Hook for agent interactions </Card>

<Card title="useAgentContext" icon="square-check" href="/reference/use-agent-context"

Hook for agent context management </Card>

<Card title="useFrontendTool" icon="hammer" href="/reference/use-frontend-tool"> Hook for frontend tools </Card>

<Card title="useHumanInTheLoop" icon="user-check" href="/reference/use-human-in-the-loop"

Hook for human-in-the-loop functionality </Card>

<Card title="useRenderToolCall" icon="paintbrush" href="/reference/use-render-tool-call"

Hook for rendering tool calls </Card>