Clear all user settings.

Record that the response was closed.

Nearest candidate name to a likely typo, if one is close enough.

Start the MCP server process and establish connection. Returns: Self for method chaining. Raises: Connection

Printable text content for chunk-like consumers.

Convert oneOf to anyOf for OpenAI compatibility. OpenAI's Structured Outputs support anyOf better than oneOf. This recursively converts all o

Convert a result string to a Pydantic model or JSON using instructions. Args: result: The result string to convert. model: The Py

Create a client from configuration using the appropriate factory. Args: config: The RAG client configuration. Returns: The c

Create state for a scoped public frame stream.

Create a mock LLM that returns a simple response. The mock includes all attributes required by the telemetry system, particularly the 'model'

Create research tools for testing structured planning.

Create a configured FileResolver. Args: provider: Optional provider name to load default threshold from constraints. prefer_uploa

Ensure all properties are in the required array for OpenAI strict mode. OpenAI's strict structured outputs require all properties to be listed

Records the coding tool environment context.

Return ``stem.jsonc`` or ``stem.json``, preferring JSONC.

Restate a containment rejection with a tool-specific remedy. Rejections from :func:`validate_file_path` end by advertising the process-wide e

Create a MergeAgentHandlerTool from a tool name. Args: tool_name: Name of the tool (e.g., "linear__create_issue")

Generate the ChatInputs required for the crew by analyzing the tasks and agents. Args: crew: The crew object containing tasks and agents.

Read message history from flow state or the internal fallback buffer.

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

Return the project name from ``pyproject.toml``.

Return a single record by ID, or None if not found. Args: record_id: The unique ID of the record. Returns: T

Get information about a scope. Args: scope: The scope path. Returns: ScopeInfo with record count, categories

Get supported MIME type prefixes for a provider. Args: provider: Provider name string. api: Optional API variant (e.g., "response

Handle OutputParserError by updating messages and formatted_answer. Args: e: The OutputParserError that occurred messages: List o

Apply the effective policy to a failure a tool just reported. Records it on the agent and emits :class:`ToolFailureDetectedEvent`. Returns th

Check if there are any built-in tool outputs.

Check if this is first time and initialize collection.

Execute the agent with given inputs. Args: inputs: Input dictionary containing prompt variables. Returns: Di

Check if code is currently running inside an asyncio event loop. This is used to detect when code is being called from within an async context

Return whether an error means native tool calling is unavailable.

Return True if *value* looks like a registry reference (@org/name).

Check if a response from the LLM is a list of tool calls. Supports OpenAI, Anthropic, Bedrock, and Gemini formats. Args: response: T

List available templates with an interactive selector to install.

List all available triggers from integrations.

Load all stored task outputs. Returns: List of task output dictionaries, or None if no outputs exist.

Load a ``Crew`` from an in-memory JSON/YAML crew definition.

Load content from a URL. Args: url: The URL to fetch content from kwargs: Additional keyword arguments (can include 'headers' ove

Promote a skill to INSTRUCTIONS disclosure level. Reads the full SKILL.md body text. Args: skill: Skill at METADATA level. Retu

Load skill inputs into de-duplicated Skill objects. Preserves first-seen order when multiple inputs resolve to the same skill name. Registry

Log successful LLM API call and track token usage.

Mark a todo as failed by step number.

Normalize a pyproject project.name into a Python package directory name. Mirrors the rules in ``crewai.cli.create_crew.create_crew`` so the v

Get the Git repository's remote URL.

Parse agent output text into AgentAction or AgentFinish. Expects output to be in one of two formats. If the output signals that an action sh

Read and parse a SKILL.md file. Args: path: Path to the SKILL.md file. Returns: Tuple of (SkillFrontmatter, body text).

Parse tools to be used for the task. Args: tools: List of tools to parse. Returns: List of structured tools. Raises:

Create interactive HTML visualization of Flow structure. Args: filename: Output HTML filename (default: "crewai_flow.html").

Pop an event entry from the scope stack.

Prepare crew for kickoff execution. Handles before callbacks, event emission, task handler reset, input interpolation, task callbacks, agent

Process the guardrail for the agent output. Args: output: The output to validate with the guardrail guardrail: The guardrail to v

Prompt for each name and return ``{name: value}``. ``describe(name)`` returns an optional hint shown dim above the prompt (used by flows to s

Remove old checkpoints, keeping at most *max_keep* per branch. Args: location: The storage destination passed to ``checkpoint``.

Register a cleanup callback on the streaming output. Ensures the event handler is unregistered even if aclose()/close() is called before iter

Return the failure to attach to ``ToolUsageFinishedEvent``. ``None`` under :attr:`ToolFailurePolicy.IGNORE`, so that policy really does surfa

Request human input during tool hook execution. This method pauses live console updates, displays a prompt to the user, waits for the

Reset all settings to default values.

Return the Python symbol named by a project definition field.

Sanitize tool name for API compatibility.

Sanitize a JSON schema for OpenAI strict function calling.

Return a scoped view of this memory.

Serialize a single guardrail value for JSON checkpointing. String descriptions are preserved; callable references cannot be JSON-serialized a

Serialize a guardrails value (single or sequence) for JSON checkpointing. Dropped callables are filtered out of lists rather than emitted as ``No

Serialize a ``type[BaseModel]`` field value as its JSON schema. Args: value: A ``type[BaseModel]`` subclass, ``None``, or another union m

Mark telemetry live (idempotent). Deliberately does not install a global TracerProvider. Doing so made every OTel-instrumented librar

True if we should auto-collect traces for first-time user. Returns: True if first-time user AND telemetry not disabled AND tracing not ex

Whether a reported failure should print its own red panel. A tool that *raised* already printed one via ``ToolUsageErrorEvent``, so o

Whether a finished tool call should print the green panel. A failed call must not read as successful, so the red panel replaces it.

Return a portable Markdown skill for authoring Flow declarations.

Update crewai dependency versions in CLI template pyproject.toml files. Uses simple string replacement instead of TOML parsing because templa

Validate and convert a JSON string to a Pydantic model or dict. Args: result: The JSON string to validate and convert. model: The

Validate a text file against general constraints. Args: file: The text file to validate. constraints: Provider constraints to val

Wrap a FileSource in the appropriate typed FileInput wrapper. Args: source: The file source to wrap. Returns: Typed FileInpu

Ensure cleanup on deletion.

Initialize the exception. Args: message: Error message describing the issue. file_name: Optional name of the file tha