---
title: eve
product: vercel
url: /docs/eve
canonical_url: "https://vercel.com/docs/eve"
last_updated: 2026-08-03
type: conceptual
prerequisites:
  []
related:
  - /docs/functions
  - /docs/workflows
  - /docs/sandbox
  - /docs/ai-gateway
  - /docs/connect
summary: Learn how to deploy and run durable backend AI agents built with the open-source eve framework on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# eve

> **💡 Note:** eve is currently in beta and subject to the
> .
> The framework, APIs, documentation, and behavior may change before general availability.


<!-- docsgraph:related -->
## Related pages

> **For AI agents:** Follow these links to understand how this page connects to the rest of the Vercel ecosystem. For the full cross-link map (inbound, outbound, prerequisites, and semantic neighbors), see the .graph.md link below.

- [Give your eve agent secure access to your private AWS RDS database](https://vercel.com/kb/guide/give-eve-agent-secure-access-to-aws-rds-database?from=related) — Connect an eve agent to a private AWS RDS database using Vercel Secure Compute and VPC peering, with a read-only query t
- [How to run a multi-step research agent on Vercel](https://vercel.com/kb/guide/how-to-run-a-multi-step-research-agent-on-vercel?from=related) — An end-to-end architecture for production research agents on Vercel using Sandbox, Workflows, and AI Gateway with isolat
- [Deployment](https://eve.dev/docs/guides/deployment/overview?from=related) — Choose a deployment strategy and prepare an eve agent for production.
- [Deploy to Vercel](https://eve.dev/docs/guides/deployment/vercel?from=related) — Deploy an eve agent with Vercel Workflow, Sandbox, Cron, and project credentials.
- [Next.js](https://eve.dev/docs/guides/frontend/nextjs?from=related) — Run an eve agent and a Next.js app as one project with withEve.
- [eve](https://eve.dev/docs/channels/eve?from=related) — The default HTTP API for an agent, covering session routes, auth, and customization.
- [Draft content in your voice from Slack with eve](https://vercel.com/kb/guide/eve-content-agent?from=related) — Deploy the eve content agent template, a Slack bot that drafts blog posts, LinkedIn posts, release notes, and newsletter
- [How to add tools to your eve agent](https://vercel.com/kb/guide/how-to-add-eve-tools?from=related) — Add tools to an eve agent by creating a TypeScript file under agent/tools/ with defineTool, and gate sensitive ones on h
- [Self-Host eve](https://eve.dev/docs/guides/deployment/self-hosting?from=related) — Run an eve agent as a Node service with your own workflow storage, sandbox backend, and routing.
- [How to build a GitHub agent with eve and GitHub Tools](https://vercel.com/kb/guide/github-agent-eve?from=related) — Build a GitHub agent with eve, GitHub Tools, and Vercel Connect. Register AI-callable GitHub tools, gate writes behind d
- [Skills](https://vercel.com/docs/agent-resources/skills?from=related) — Install skills to enhance AI coding agents with specialized capabilities for React, Next.js, deployment, and more.

Full cross-link map for this page: [/docs/eve.graph.md](/docs/eve.graph.md)
<!-- /docsgraph:related -->

[eve](https://eve.dev/) is an open-source, filesystem-first framework for durable backend AI agents. You define each
agent with files under an `agent/` directory, and eve discovers those files and compiles them into a
runnable app. eve runs locally, on Vercel, or on a long-running Node.js host, and can use AI Gateway
or call AI SDK model providers directly.

These docs cover deploying and running eve on Vercel. In this environment, the compiled app runs on
[Vercel Functions](/docs/functions) and integrates with these services:

- [Vercel Workflows](/docs/workflows) persist session state and resume interrupted work.
- [Vercel Sandbox](/docs/sandbox) isolates code execution.
- [AI Gateway](/docs/ai-gateway) routes model requests and handles provider fallbacks.
- [Vercel Connect](/docs/connect) manages OAuth tokens and API keys for external services.
- [Vercel Observability](/docs/observability) shows agent runs, token usage, and performance.

## Getting started

The fastest path is the eve CLI. Run the published package with `npx` to scaffold a new
agent project, install dependencies, initialize Git, and start the development server:

```bash
npx eve@latest init my-agent
```

To add eve to an existing app, follow the [quickstart steps](https://eve.dev/docs/getting-started#quick-start).

Follow the generated README for the project-specific dev command, or run the agent locally with the
standard script from the scaffold:

```bash
pnpm dev
```

See the [eve Getting Started guide](https://eve.dev/docs/getting-started) for the complete setup,
local development, and first-session walkthrough.

## Define an agent

A minimal agent is two files. `agent/instructions.md`:

```md
You are a concise assistant. Use tools when they are available.
```

And `agent/agent.ts`:

```ts
import { defineAgent } from 'eve';

export default defineAgent({
  model: 'openai/gpt-5.4-mini',
});
```

eve resolves model strings such as `openai/gpt-5.4-mini` through [AI Gateway](/docs/ai-gateway), so
on Vercel you authenticate with OIDC and don't need to manage provider API keys.

### Add a tool

Each file in `agent/tools/` is one tool. Create `agent/tools/get_weather.ts`:

```ts
import { defineTool } from 'eve/tools';
import { z } from 'zod';

// The runtime tool name comes from the filename, so the model sees `get_weather`.
export default defineTool({
  description: 'Get the current weather for a city.',
  inputSchema: z.object({
    city: z.string(),
  }),
  async execute(input) {
    return { city: input.city, condition: 'Sunny', temperatureF: 72 };
  },
});
```

## Start a session

Start a durable session and stream its output:

```bash
curl -X POST http://127.0.0.1:3000/eve/v1/session \
  -H 'content-type: application/json' \
  -d '{"message":"What is the weather in Brooklyn?"}'
```

The response returns a `continuationToken` in the body and an `x-eve-session-id` header. Attach to
the session stream to receive NDJSON lifecycle events:

```bash
curl http://127.0.0.1:3000/eve/v1/session/<sessionId>/stream
```

## Features

- [**Agent project**](/docs/eve/concepts#agent-project): Author an agent from files under
  `agent/`, including instructions, runtime config, tools, skills, channels, connections, and a
  sandbox.
- [**Durable sessions**](/docs/eve/concepts#sessions-and-turns): Create sessions that stream
  incremental output and resume after cold starts, deploys, or long pauses.
- [**Tools and skills**](/docs/eve/concepts#tools-and-skills): Give the model typed actions and
  load larger procedures only when relevant.
- [**Agent Runs**](/docs/eve/observability): Inspect sessions, turns, tools, reasoning, timing, and
  token usage in the Vercel dashboard.

## Resources

**eve documentation**: Explore the complete framework documentation, including guides, channels, tools, skills, and API references. [Learn more →](https://eve.dev/docs)

**Concepts**: Learn how eve agents, sessions, channels, tools, skills, connections, and sandboxes fit together. [Learn more →](/docs/eve/concepts)

**Pricing and Limits**: Understand how eve usage maps to Vercel resources and inherited platform limits. [Learn more →](/docs/eve/pricing)

**Observability**: Inspect agent runs in the Vercel dashboard with no setup, and optionally export AI SDK spans through OpenTelemetry. [Learn more →](/docs/eve/observability)


---

[View full sitemap](/docs/sitemap)
