> For the complete documentation index, see [llms.txt](https://docs.zerve.ai/zerve-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zerve.ai/zerve-docs/ship-your-work/shipping.md).

# Deployments overview

Turn your work into apps, APIs, scheduled jobs and reports.

When your analysis or model is ready, Zerve can turn it into something other people and systems can use.

| To                                        | Use                                                                                |
| ----------------------------------------- | ---------------------------------------------------------------------------------- |
| Share an interactive dashboard or tool    | An [app](/zerve-docs/ship-your-work/apps.md), built with Streamlit, Gradio or Dash |
| Let other systems call your model or code | An [API](/zerve-docs/ship-your-work/apis.md), built with FastAPI or Flask          |
| Run a workflow automatically              | A [scheduled job](/zerve-docs/ship-your-work/scheduled-jobs.md)                    |
| Summarize findings for stakeholders       | A [report](/zerve-docs/ship-your-work/reports.md)                                  |

## Deploying from a notebook

In the notebook view, open **Deploy** and choose a deployment type:

| Group                 | Options                                         |
| --------------------- | ----------------------------------------------- |
| **Web Applications**  | **Streamlit**, **Gradio** or **Dash**           |
| **API Services**      | **FastAPI** or **Flask**                        |
| **Custom Deployment** | **Custom**: bring your own code and run command |

Your deployment's code can use variables from your notebook:

```python
from zerve import variable

employees = variable("employee_data", "employees")
```

The first argument is the block's name, and the second is the variable's name. So when you retrain a model in the notebook, a redeployed app or API uses the new version.

## Deployment settings

| Setting           | Details                                                                                                                             |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| **DNS name**      | The name in the deployment's web address. Zerve shows the full address as you type.                                                 |
| **Instance type** | The size of the machine it runs on (see below)                                                                                      |
| **Environment**   | The environment it runs in. Each framework has a default environment, or choose one of your project's environments to add packages. |
| **Run command**   | For custom deployments, the command that starts your app, such as `uvicorn main:app --host 0.0.0.0 --port 80`                       |

### Instance types

Active deployments use credits while they run.

| Instance     | CPU | Memory | Credits per hour |
| ------------ | --- | ------ | ---------------- |
| **Small**    | 1   | 8 GB   | 1.12             |
| **Medium**   | 2   | 16 GB  | 2.1              |
| **Large**    | 4   | 30 GB  | 3.83             |
| **X-Large**  | 8   | 60 GB  | 7.68             |
| **XX-Large** | 16  | 120 GB | 15.48            |

On the Free plan, choosing an instance type requires upgrading. If your organization runs Zerve in its [own cloud](/zerve-docs/self-hosting/self-hosting.md), deployments run on your infrastructure, which usually uses fewer credits.

## Previewing before you deploy

Start a **preview deployment** to test your app or API before deploying it. The preview has three tabs:

| Tab                 | What it's for                     |
| ------------------- | --------------------------------- |
| **Web Preview**     | Trying your app                   |
| **HTTP Playground** | Sending test requests to your API |
| **Logs**            | Debugging                         |

## Deployment progress

| Status                  | Meaning                           |
| ----------------------- | --------------------------------- |
| **Initializing**        | The deployment has been requested |
| **Building**            | Zerve is building its image       |
| **Deploying**           | Zerve is starting it              |
| **Active**              | It's running                      |
| **Error**               | It failed. Check the logs.        |
| **Stopping deployment** | It's being shut down              |

Building and deploying usually take a few minutes.

## Deployments and the agent

Zerve's agents can deploy apps and APIs for you. They ask before starting, updating or stopping a deployment, unless you've turned that off. See [Agent approvals and governance](/zerve-docs/security/agent-approvals-and-governance.md).

## Finding your deployments

Select **Deployments** in the Workspace sidebar to see all your deployments.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zerve.ai/zerve-docs/ship-your-work/shipping.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.