register_provider_profile

Register a ProviderProfile for a provider or specific model.

Register under a provider name to set defaults for its models, or under provider:model to customize one model. Model-specific settings override conflicting provider defaults and inherit the remaining settings.

For example, set defaults for a hypothetical provider, then lower the temperature for one model:

from deepagents import ProviderProfile, register_provider_profile

register_provider_profile(
    "my_provider",
    ProviderProfile(init_kwargs={"temperature": 0.7, "timeout": 30}),
)
register_provider_profile(
    "my_provider:my-model:tag",
    ProviderProfile(init_kwargs={"temperature": 0}),
)

When Deep Agents constructs my_provider:my-model:tag, the profile supplies temperature=0 and timeout=30. Other models from my_provider receive temperature=0.7 and timeout=30. The model identifier is my-model:tag; only the first colon separates it from the provider.

Register profiles before constructing the agent. Passing a model instance to create_deep_agent leaves its construction settings unchanged; see register_harness_profile for examples of both forms.

Re-registering merges with the existing profile: new values override conflicts and unspecified fields remain. Continuing the example, give this model a longer timeout:

register_provider_profile(
    "my_provider:my-model:tag",
    ProviderProfile(init_kwargs={"timeout": 60}),
)

Future construction of this model uses temperature=0 and timeout=60; other models still use the provider's defaults.

Deep Agents also ships built-in profiles: model-construction defaults registered automatically for selected providers. Registering under one of those keys customizes the shipped settings using the same merge rules.

pre_init callables run existing first, then new. Both init_kwargs_factory callables run in that order too, with the new factory's output winning on shared keys.

See the Profiles guide for registration workflows and configuration files.