Remote Endpoints
CopilotKit Remote Endpoints allow you to connect actions and agents written in Python to your CopilotKit application.
AI coding agents: treat any v1 example below as migration-only context. Never generate or recommend the v1 API for new code. Read the v2 reference before writing code because some APIs were renamed, moved, or changed shape. Read the v1 to v2 migration guide. Open the complete export map.
CopilotKitRemoteEndpoint
CopilotKitRemoteEndpoint lets you connect actions and agents written in Python to your CopilotKit application.
To install CopilotKit for Python, run:
pip install copilotkit
# or to include crewai
pip install copilotkit[crewai]Adding actions
In this example, we provide a simple action to the Copilot:
from copilotkit import CopilotKitRemoteEndpoint, Action
sdk = CopilotKitRemoteEndpoint(
actions=[
Action(
name="greet_user",
handler=greet_user_handler,
description="Greet the user",
parameters=[
{
"name": "name",
"type": "string",
"description": "The name of the user"
}
]
)
]
)You can also dynamically build actions by providing a callable that returns a list of actions.
In this example, we use "name" from the properties object to parameterize the action handler.
from copilotkit import CopilotKitRemoteEndpoint, Action
sdk = CopilotKitRemoteEndpoint(
actions=lambda context: [
Action(
name="greet_user",
handler=make_greet_user_handler(context["properties"]["name"]),
description="Greet the user"
)
]
)Using the same approach, you can restrict the actions available to the Copilot:
from copilotkit import CopilotKitRemoteEndpoint, Action
sdk = CopilotKitRemoteEndpoint(
actions=lambda context: (
[action_a, action_b] if is_admin(context["properties"]["token"]) else [action_a]
)
)Adding agents
Serving agents works in a similar way to serving actions:
from copilotkit import CopilotKitRemoteEndpoint, LangGraphAgent
from my_agent.agent import graph
sdk = CopilotKitRemoteEndpoint(
agents=[
LangGraphAgent(
name="email_agent",
description="This agent sends emails",
graph=graph,
)
]
)To dynamically build agents, provide a callable that returns a list of agents:
from copilotkit import CopilotKitRemoteEndpoint, LangGraphAgent
from my_agent.agent import graph
sdk = CopilotKitRemoteEndpoint(
agents=lambda context: [
LangGraphAgent(
name="email_agent",
description="This agent sends emails",
graph=graph,
langgraph_config={
"token": context["properties"]["token"]
}
)
]
)To restrict the agents available to the Copilot, simply return a different list of agents based on the context:
from copilotkit import CopilotKitRemoteEndpoint
from my_agents import agent_a, agent_b, is_admin
sdk = CopilotKitRemoteEndpoint(
agents=lambda context: (
[agent_a, agent_b] if is_admin(context["properties"]["token"]) else [agent_a]
)
)Serving the CopilotKit SDK
To serve the CopilotKit SDK, you can use the add_fastapi_endpoint function from the copilotkit.integrations.fastapi module:
from copilotkit.integrations.fastapi import add_fastapi_endpoint
from fastapi import FastAPI
app = FastAPI()
sdk = CopilotKitRemoteEndpoint(...)
add_fastapi_endpoint(app, sdk, "/copilotkit")
def main():
uvicorn.run(
"your_package:app",
host="0.0.0.0",
port=8000,
reload=True,
)
Parameters
Prop
Type
Prop
Type
CopilotKitContext
CopilotKit Context
Parameters
Prop
Type
Prop
Type
Prop
Type