Resume Live session updates after human input is complete. New streaming sessions will be created on-demand when needed. This method

Generate structured output using the specified Pydantic model. Returns: Instance of the specified Pydantic model with structured

Collapse free-form feedback to a predefined outcome using LLM. This method uses the specified LLM to interpret the human's feedback a

Read a file, or a window of its lines, as text.

Process input text synchronously.

Split messages into chunks at message boundaries. Excludes system messages and expands oversized single messages before chunking. Each chunk

A CrewAI AMP client stub serving one skill.

Add a new task output to storage. Args: task: The task that was executed. output: The output produced by the task.

Create a minimal valid PNG for testing.

Delete an uploaded file. Args: file_id: The file identifier to delete. Returns: True if deletion was success

Deploy a crew using either UUID or project name. Args: uuid (Optional[str]): The UUID of the crew to deploy.

End an execution context owned by the current kickoff. Nested kickoffs pass ``None`` and leave the outer uuid in place.

Execute a single native tool call with full lifecycle management. Handles: arg parsing, tool lookup, max-usage check, cache read/write, befor

Execute *sql_query* and return the results as a list of dicts. Parameters ---------- sql_query: The SQL statement

Emit a final ``FlowFinishedEvent`` and finish the execution trace. Pairs with ``flow.defer_trace_finalization = True`` (or ``Conversa

Restore a Crew from a checkpoint, ready to resume via kickoff(). Args: config: Checkpoint configuration with ``restore_from`` set

Parse the ``application[/action][@connection_uuid|private]`` syntax. Raises: ValueError: If the selector does not follow the supp

Get all registered global after_llm_call hooks. Returns: List of registered after hooks

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

Parse a registry reference into its organisation, name and version. Accepts '@org/skill-name' and the version-pinned '@org/skill-name@1.2.0'

Retrieve relevant memories. ``shallow`` embeds the query directly and runs a single vector search. ``deep`` (default) uses the Recall

Import a module, optionally returning a specific attribute. Args: name: The module name to import. purpose: Description of what r

Execute the crew and capture the result.

Validate a video file against constraints. Args: file: The video file to validate. constraints: Video constraints to validate aga

Create a simple analyst crew for file analysis.

Create a batch slice from prepared documents. Args: prepared: PreparedDocuments containing ids, texts, and metadatas. start_index

Emit stream chunk event. Args: chunk: The text content of the chunk. from_task: The task that initiated the call.

LiteLLM responses/chunks share the choices-shape with OpenAI/Azure; delegate to the shared extractor.

Find the CheckpointConfig for an event source. Walks known relationships: Task -> Agent -> Crew. Flow and Agent carry their own checkpoint fi

Format messages with role labels for summarization. Skips system messages. Handles None content, tool_calls, and multimodal content blocks.

Apply the executor's stop words to the LLM for the duration of one call. Uses :func:`crewai.llms.base_llm.call_stop_override` so the LLM's stop

Save task result to unified memory (memory or crew._memory).

Show version update message if a newer version is available. Only displays when verbose mode is enabled and not running in CI/CD.

Validate and parse structured output. Args: response: Raw response string response_format: Optional Pydantic model fo

Add a tool result to the cache. Declared failures are never stored: replaying one would make a transient error permanent for the rest

Build a comprehensive field description including constraints. Embeds format, enum, pattern, min/max, and example constraints into the descri

Build a tool whose every scrape entrypoint answers with ``raw_response``. ``sdk_logs`` reproduces the oxylabs SDK's habit of logging the real cau

Convert a result to a Pydantic model or JSON. Args: result: The result to convert. Usually a JSON string, but a Pydantic inst

Create an agent executor for the agent. Returns: An instance of the CrewAgentExecutor class.

Enforce the requests per minute (RPM) limit if applicable. Args: request_within_rpm_limit: Function to enforce RPM limit.

Own buffering and consent; activation can change between deferred turns.

Execute an action with the given arguments.

Freeze the current Edge into ``docs/v<version>/`` and update docs.json. Args: version: Release version as ``"X.Y.Z"`` (no leading ``v``).

Build an expression with the standard Flow runtime context.

Convert MCP server references/configs to CrewAI tools. Delegates to :class:`~crewai.mcp.tool_resolver.MCPToolResolver`.

Increment the tools errors counter.

Executes the Crew's workflow for each input and aggregates results. Args: inputs: List of input dictionaries, one per execution.

List records in a scope, newest first. Args: scope: Optional scope path prefix to filter by. If None and root_scope

Load the most recent state for a given flow UUID. Args: flow_uuid: Unique identifier for the flow instance Returns:

Register a global after_llm_call hook. Global hooks are added to all executors automatically. This is a convenience function for registering

Reset specific or all memories for the crew. Args: command_type: Type of memory to reset. Valid options: 'memory'

GET a URL through :func:`safe_get`, refusing bodies over *max_bytes*. The body is streamed and abandoned as soon as it crosses the limit, so an

Search for similar documents using a query. Keyword Args: collection_name: Name of the collection to search in. query

Set available input files. Args: files: Dictionary mapping file names to file inputs.

Get the git status in porcelain format.

Generate a standard prompt for task execution. Returns: A dictionary containing the constructed prompt(s).

Capture a crew or flow using the enterprise event/session lifecycle. Hosts supply verified identity, collectors, resources, span processors,

Save the documents to the storage asynchronously. This method should be called after the chunks and embeddings are generated. Raises

Build a minimal docs/ tree with one previous snapshot + Edge + docs.json. The shape mirrors the real repo: an Edge directory with per-locale fold

Turn a raw import-time exception into a user-actionable finding.

Run one telemetry span method against a mocked tracer. The singleton is reset first: it caches the provider built on the very first construct

Extract token usage and response metadata from Anthropic response.

Get or create a code interpreter for the specified thread. Args: thread_id: Thread ID for the code interpreter session R

Return ``True`` if *fn* cannot survive a serialize/deserialize round-trip. Built-in functions, plain module-level functions, and classes produce

Read the user-data JSON file, returning ``{}`` on missing/corrupt.

Prepare documents for ChromaDB by extracting IDs, texts, and metadata. Args: documents: List of BaseRecord documents to prepare. Ret

Whether a 400 is the server refusing `reasoning_effort` for this model. Non-reasoning models reject the parameter itself, in one of two shape

Resolve an ``MCPServerConfig`` into tools. Returns ``(tools, clients)`` where *clients* is always empty for native tools (clients are

Run an async coroutine from sync context without blocking event loop.

Set status for an explicit plan step reported by the planner.

Promote a skill to INSTRUCTIONS disclosure level. Idempotent: returns the skill unchanged if already at or above INSTRUCTIONS. Args: