# InstantDeploy.site

> Free, instant web hosting for AI agents. Publish any static site and get a live URL in seconds.

InstantDeploy.site provides static file hosting at:

    https://<slug>.instantdeploy.site/

Agents can publish anonymously (24 hour expiry) or with an API key (permanent/custom TTL).

## Install InstantDeploy

- Install guide: https://instantdeploy.site/docs
- Install/update command:

    curl -fsSL https://instantdeploy.site/install.sh | bash

## API basics

- Base URL: https://api.instantdeploy.site
- Create deployment: POST /v1/ship (multipart/form-data with `file` archive)
- List recent deployments: GET /v1/deployments
- Get remixable files: GET /v1/remix/{slug}

### Auth modes

- Anonymous: omit the Authorization header. Deploys expire in 24 hours.
- Authenticated: include `Authorization: Bearer <API_KEY>`. Deploys are associated with the user and can be listed in the dashboard.

## Auth

- Sign up: POST /v1/auth/signup `{ "email": "user@example.com", "password": "min8chars" }`
- Sign in: POST /v1/auth/login `{ "email": "user@example.com", "password": "..." }`
- Current user: GET /v1/auth/me (requires session cookie)
- Sign out: POST /v1/auth/sign-out
- Auth is modal-only on web; /login and /auth/verify redirect to /

### How AI agents get an API key (for POST /v1/ship)

1. Sign up: `POST /v1/auth/signup` with JSON body `{ "email": "...", "password": "..." }` — include `credentials: include` to receive the session cookie.
2. Get API key: `GET /v1/auth/me` with the same cookie/credentials — response includes `api_key`.
3. Deploy: `POST /v1/ship` with header `Authorization: Bearer <api_key>` — deployments are claimed to the user and persist.

Optional: Set a custom API key — `POST /v1/dashboard/set-api-key` with body `{ "api_key": "your-24-64-char-key" }` (url-safe: A-Za-z0-9_-). Generate new: `POST /v1/dashboard/regenerate-api-key`.

## Limits (initial)

- Anonymous max file size: 100 MB
- Expiry: 24 hours for anonymous deploys
- Rate limit: configured per-IP on the API

## Notes for agents

- Always return the `url` (deployment URL) and `slug` to the user.
- For anonymous publishes, remind the user that deploys expire in 24 hours.
- For authenticated publishes, prefer `Authorization: Bearer <API_KEY>` so sites show up in the dashboard.