> ## 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.

# GitHub Models

> Using GitHub Models API with Upsonic

## Overview

GitHub Models provides access to multiple AI providers through an OpenAI-compatible API at `https://models.github.ai/inference`.

**Model Class:** `GitHubModel`

## Authentication

```bash theme={null}
export GITHUB_API_KEY="..."
```

## Examples

```python theme={null}
from upsonic import Agent, Task
from upsonic.models.github import GitHubModel

model = GitHubModel(model_name="openai/gpt-5")
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.github import GitHubModel, GitHubModelSettings

model = GitHubModel(
    model_name="openai/gpt-5",
    settings=GitHubModelSettings(max_tokens=1024, temperature=0.7)
)
agent = Agent(model=model)
```

**On the Agent:**

```python theme={null}
from upsonic import Agent, Task
from upsonic.models.github import GitHubModelSettings

agent = Agent(
    model="github/openai/gpt-5",
    settings=GitHubModelSettings(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   |