# Modal (/integrations/modal)

Use [Modal](https://modal.com/) to call a deployed Web Function or Server over HTTPS, generate chat completions from a model served on a Modal Endpoint, or list available models.

Create a proxy auth token in the Modal workspace settings and provide its token ID and secret. The endpoint or function must already be deployed; the block invokes it rather than provisioning compute.

## Use the block \[#usage-instructions]

Invoke a deployed Web Function or Server over HTTPS with proxy-token auth, generate completions from a model served by a Modal Endpoint, and list the models a token can reach.

## Actions \[#actions]

### Modal Call Function \[#modal-call-function]

Invoke a deployed Modal Web Function or Server over HTTPS

#### Input \[#input]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `url` | string | Yes | Public URL of the deployed Modal Web Function or Server (e.g., <https://your-workspace--your-app-your-function.modal.run>) |
| `method` | string | No | HTTP method to use: GET, POST, PUT, PATCH, DELETE, or HEAD |
| `body` | json | No | JSON request body sent to the function |
| `queryParams` | json | No | Query parameters to append to the URL as key-value pairs |
| `headers` | json | No | Additional request headers as key-value pairs |
| `tokenId` | string | No | Modal proxy token ID (wk-...), required for authenticated functions |
| `tokenSecret` | string | No | Modal proxy token secret (ws-...), required for authenticated functions |

#### Output \[#output]

| Parameter | Type | Description |
| - | - | - |
| `data` | json | Body returned by the function — parsed JSON when it responds with application/json, otherwise the raw text |
| `status` | number | HTTP status code of the response |
| `headers` | json | Response headers as key-value pairs |

### Modal Chat Completion \[#modal-chat-completion]

Generate a chat completion from a model served by a Modal Endpoint

#### Input \[#input-1]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `endpointUrl` | string | No | Endpoint URL from the Modal dashboard or `modal endpoint list`. Defaults to <https://inference.us-west.modal.direct>, which routes to Shared Endpoints on the model ID |
| `model` | string | Yes | Model to generate with — the base model repo ID for a dedicated endpoint, or the endpoint hostname for a Shared Endpoint |
| `content` | string | Yes | The user message content to send to the model |
| `systemPrompt` | string | No | System prompt to guide the model behavior |
| `maxTokens` | number | No | Maximum number of tokens to generate |
| `temperature` | number | No | Sampling temperature (e.g., 0 for deterministic, 0.7 for creative) |
| `topP` | number | No | Nucleus sampling probability mass between 0 and 1 |
| `tokenId` | string | Yes | Modal proxy token ID (wk-...) |
| `tokenSecret` | string | Yes | Modal proxy token secret (ws-...) |

#### Output \[#output-1]

| Parameter | Type | Description |
| - | - | - |
| `content` | string | Generated text content |
| `model` | string | Model that produced the completion |
| `finishReason` | string | Why generation stopped (e.g., stop, length) |
| `usage` | object | Token usage reported by the endpoint |
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
| ↳ `completion_tokens` | number | Number of tokens in the completion |
| ↳ `total_tokens` | number | Total number of tokens used |

### Modal List Models \[#modal-list-models]

List the model IDs a Modal proxy token can reach on an endpoint

#### Input \[#input-2]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `endpointUrl` | string | No | Endpoint URL to query. Defaults to <https://inference.us-west.modal.direct>, which lists every Shared Endpoint the token can reach |
| `tokenId` | string | Yes | Modal proxy token ID (wk-...) |
| `tokenSecret` | string | Yes | Modal proxy token secret (ws-...) |

#### Output \[#output-2]

| Parameter | Type | Description |
| - | - | - |
| `models` | array | Models the token can reach on the endpoint |
| `count` | number | Number of models returned |