CopilotKit

CrewAI SDK

The CopilotKit CrewAI SDK for Python allows you to build and run CrewAI agents with CopilotKit.

v1 SDK deprecated. Use v2 instead This page is in the deprecated CopilotKit v1 reference. Do not use v1 APIs for new code; use v2 instead. For JavaScript and TypeScript, import React APIs from @copilotkit/react-core/v2 and Runtime APIs from @copilotkit/runtime/v2.
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.

copilotkit_predict_state

Stream tool calls as state to CopilotKit.

To emit a tool call as streaming CrewAI state, pass the destination key in state, the tool name and optionally the tool argument. (If you don't pass the argument name, all arguments are emitted under the state key.)

from copilotkit.crewai import copilotkit_predict_state

await copilotkit_predict_state(
    {
        "steps": {
            "tool_name": "SearchTool",
            "tool_argument": "steps",
        },
    }
)

Parameters

Prop

Type

Returns

Prop

Type

copilotkit_emit_message

Manually emits a message to CopilotKit. Useful in longer running nodes to update the user. Important: You still need to return the messages from the node.

Examples

from copilotkit.crewai import copilotkit_emit_message

message = "Step 1 of 10 complete"
await copilotkit_emit_message(message)

# Return the message from the node
return {
    "messages": [AIMessage(content=message)]
}

Parameters

Prop

Type

Returns

Prop

Type

copilotkit_emit_tool_call

Manually emits a tool call to CopilotKit.

from copilotkit.crewai import copilotkit_emit_tool_call

await copilotkit_emit_tool_call(name="SearchTool", args={"steps": 10})

Parameters

Prop

Type

Prop

Type

Returns

Prop

Type