True when a crew runs inside a flow session (context or batch ownership).

Accept a prompt string or a rendered conversation. A whole-string ``${...}`` template keeps its evaluated type, so a CEL expression over ``st

Parse an AMP reference into *(slug, optional tool name)*. Accepts both bare slugs (``"notion"``, ``"notion#search"``) and the legacy

Parse the LLM response into a StepObservation. The LLM may return: - A StepObservation instance directly (streaming + litellm path)

Read raw bytes from a secure file, or None if absent.

Subclass must implement: transform validated params dict into API request params.

Return the bound ``Memory`` or raise a clear error if missing.

Coerce a checkpoint field value. Returns: CheckpointConfig — use this config. _SENTINEL — explicit opt-out (``False``), stop walk

Emit agent execution event. Args: formatted_answer: Agent's response to log.

Build an in-memory tar archive via `build(tf)` and return it for reading.

Extract timestamp from checkpoint ID or filename.

Use trained data for the agent task prompt to improve output.

Download a template and copy it into the current working directory. Args: name: Template name (with or without the template_ pref

Add usage metrics from another UsageMetrics object. Args: usage_metrics: The usage metrics to add.

Call the LLM asynchronously and return the response. Args: llm: The LLM instance to call. messages: The messages to send to the L

Get an existing collection or create it if it doesn't exist asynchronously. Keyword Args: collection_name: Name of the collection

Cancel an A2A task. Publishes a cancel event that the cancellable decorator listens for. Args: context: The A2A request context cont

Split a PDF into chunks of maximum page count. Yields chunks one at a time to minimize memory usage. Args: file: The PDF file to chu

Clear all registered global after_tool_call hooks. Returns: Number of hooks that were cleared Example: >>> register_after_to

Build the attributes every span carries, once per process. Cached because it reads the project's ``pyproject.toml``, and because a process ca

Open a TCP socket to *host* after validating and pinning the peer IP.

Creates the Content Crew

Build the default flow persistence backend. Returns the result of the registered factory if one is set, otherwise a built-in :class:`~crewai.

Disconnect from MCP server and cleanup resources.

Execute a tool and check if the result should be treated as a final answer. This function integrates tool hooks for before and after tool executi

Execute crew with trigger payload.

Create a gRPC channel for the given URL.

Build a :class:`ToolFailure` from an exception a tool raised.

Search exceptions for the one that explains why a connection failed. A failing transport cancels the coroutine that was waiting on it, so the

Return a path label that does not expose absolute directory prefixes.

Format text as a content block for the LLM. Default implementation uses OpenAI/Anthropic format. Subclasses should override for provi

Get A2A agent configs and response model. Args: a2a_config: A2A configuration (any type). Returns: Tuple of client A2A confi

Get the dimensions of an image file. Args: file: The image file to measure. Returns: Tuple of (width, height) in pixels, or

Return the latest non-yanked PyPI version of CrewAI, or ``None`` on failure.

Call the LLM and return the response, handling any invalid responses. Args: llm: The LLM instance to call. messages: The messages

Get all pending todos. Returns: List of pending TodoItem objects.

Get the current human input provider. Returns: The current provider, or a new SyncHumanInputProvider if none set.

Handles the case when the maximum number of iterations is exceeded. Performs one more LLM call to get the final answer. Args: formatted_a

Handle partial JSON in a result string and convert to Pydantic model or dict. Args: result: The result string to process. model:

Check if the maximum number of iterations has been reached. Args: iterations: Current number of iterations. max_iterations: Maxim

Return True if the user has explicitly declined trace collection.

Return True when the enterprise non-interactive mode is enabled.

Return True if the Git repository is fully synced with the remote, False otherwise.

Execute the agent asynchronously with the given messages. This is the async version of the kickoff method that uses native async exec

Load prompts from a JSON file. Returns: The I18N instance with loaded prompts. Raises: Exception: If the pro

Log in to the tool repository. This request is authenticated, so sending user_identifier and project_id alongside it links the accoun

Mark that events have been collected during execution.

Convert a list of file sources to a named dictionary of FileInputs. Args: input_files: List of file source inputs or File objects. R

Process a single file according to constraints and its mode mode. Args: file: The file to process. Returns:

Records that the CLI scaffolded a new project. Acquisition was previously only observable from a project's first *run*, which misses

Resize an image to fit within the specified dimensions. Args: file: The image file to resize. max_width: Maximum width in pixels.

Restore the event scope stack from a checkpoint.

Push the latest recorded ``task_started`` scope for a task. Args: task_id: The task identifier to look up in the active event record.

Run all ``post_tool_call`` hooks against a context. Returns: The (possibly modified) tool result carried on the context.

Run all ``pre_tool_call`` hooks against a context. Returns: True if a hook blocked execution (returned False or raised :class:`Ho

Safely extract and validate tool information. Combines extraction, validation, and logging for robust tool conversion. Args: tool: T

Set a CLI configuration parameter.

Set the cache handler for the agent. Args: cache_handler: An instance of the CacheHandler class.

Set the ID of the last emitted event. Args: event_id: The event_id to set as the last emitted event.

Set whether to suppress tracing-related console messages. Args: suppress: True to suppress messages, False to show them. Returns:

Setup event listeners - delegates to specific handlers. Args: crewai_event_bus: The event bus to register listeners on.

Start the MCP server and initialize the tools.

Records redeploying an existing crew (``crewai deploy push``). Also emits ``deploy:pushed`` so that deployments are countable from the

Run the LLM call and stream scoped public ``StreamFrame`` events.

Append a user message and stream one conversational turn as frames.

Iterate over frames, optionally filtered by channel.

Serialize context to a dictionary for persistence. Returns: Dictionary representation suitable for JSON serialization.

Retrieve a tool prompt by key. Args: tool: The key of the tool prompt to retrieve. Returns: The tool prompt

Update a record by upserting with the same point ID.

Update workspace dependency versions in pyproject.toml. Args: file_path: Path to pyproject.toml file. new_version: New version st

Show the installed version of crewai.

Add message to state conversation history. Args: text: Message content. role: Message role (default: assistant).

Create a file only if it doesn't already exist.

Build a realistic multi-turn conversation for summarization tests.

Convert a config dict from crewai-oauth into an MCPServerConfig.

Calls the LLM with function calling to get a plan. Args: prompt: The prompt to send to the LLM. plan_type: The type o

Clear the read and write streams.

Build the process-wide span attributes with a stubbed project id.

Return the definition that describes this flow's methods. Prefers the instance definition, which is the loaded declaration for a flow

Convert contents to dict format.