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

# Heroku

> Using Heroku Inference API with Upsonic

## Overview

Heroku provides an OpenAI-compatible inference API. The default base URL is `https://us.inference.heroku.com` (with `/v1` appended). You can override it with `HEROKU_INFERENCE_URL` or pass `base_url` to `HerokuProvider`.

**Model Class:** `HerokuModel`

## Authentication

```bash theme={null}
export HEROKU_INFERENCE_KEY="..."
# Optional: custom base URL (without /v1)
export HEROKU_INFERENCE_URL="https://us.inference.heroku.com"
```

## Examples

```python theme={null}
from upsonic import Agent, Task
from upsonic.models.heroku import HerokuModel

model = HerokuModel(model_name="claude-sonnet-4-6")
agent = Agent(model=model)

task = Task("Hello, how are you?")
result = agent.do(task)
print(result)
```

## Model Settings

You can set model parameters in two ways: on the model or on the Agent.

**On the model:**

```python theme={null}
from upsonic import Agent, Task
from upsonic.models.heroku import HerokuModel, HerokuModelSettings

model = HerokuModel(
    model_name="claude-sonnet-4-6",
    settings=HerokuModelSettings(max_tokens=1024, temperature=0.7)
)
agent = Agent(model=model)
```

**On the Agent:**

```python theme={null}
from upsonic import Agent, Task
from upsonic.models.heroku import HerokuModelSettings

agent = Agent(
    model="heroku/claude-sonnet-4-6",
    settings=HerokuModelSettings(max_tokens=1024, temperature=0.7)
)
```

## Parameters

| Parameter             | Type        | Description                    | Default       | Source |
| --------------------- | ----------- | ------------------------------ | ------------- | ------ |
| `max_tokens`          | `int`       | Maximum tokens to generate     | Model default | Base   |
| `temperature`         | `float`     | Sampling temperature (0.0-2.0) | 1.0           | Base   |
| `top_p`               | `float`     | Nucleus sampling               | 1.0           | Base   |
| `seed`                | `int`       | Random seed                    | None          | Base   |
| `stop_sequences`      | `list[str]` | Stop sequences                 | None          | Base   |
| `presence_penalty`    | `float`     | Token presence penalty         | 0.0           | Base   |
| `frequency_penalty`   | `float`     | Token frequency penalty        | 0.0           | Base   |
| `parallel_tool_calls` | `bool`      | Allow parallel tools           | True          | Base   |
| `timeout`             | `float`     | Request timeout (seconds)      | 600           | Base   |