> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Add Runtime Alias • AI Agent SDK

> add_runtime_alias: Add an alias for a runtime.

# add\_runtime\_alias

<div className="flex items-center gap-2">
  <Badge color="teal">Function</Badge>
</div>

> This function is defined in the [**registry**](../modules/registry) module.

Add an alias for a runtime.

## Signature

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
def add_runtime_alias(alias: str, canonical_runtime_id: str) -> None
```

## Parameters

<ParamField query="alias" type="str" required={true}>
  Alias name
</ParamField>

<ParamField query="canonical_runtime_id" type="str" required={true}>
  The canonical runtime ID this alias points to
</ParamField>

### Exceptions

<AccordionGroup>
  <Accordion title="ValueError">
    If canonical runtime ID is not registered
  </Accordion>
</AccordionGroup>

## Uses

* `_global_registry.add_alias`

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/runtime/registry.py#L367">
  `praisonaiagents/runtime/registry.py` at line 367
</Card>