Skip to main content

runtm-api

FastAPI control plane for Runtm. See the API docs for endpoint reference.

Hosted API: app.runtm.com

Endpoints

Method Path Description
POST /v0/deployments Create deployment (multipart: manifest + artifact.zip)
GET /v0/deployments/:id Get deployment status, URL, timestamps, error
GET /v0/deployments/:id/logs Get build/deploy logs

Creating Deployments

POST /v0/deployments

Creates a new deployment or redeploys an existing one (based on manifest name).

Query Parameters:

  • new=true - Force creation of new deployment instead of redeploying existing
  • tier=starter|standard|performance - Override machine tier from manifest

Request:

  • manifest (file) - runtm.yaml manifest file
  • artifact (file) - artifact.zip containing project files

Headers:

  • Authorization: Bearer <token> - API authentication token
  • Idempotency-Key: <key> - Optional idempotency key for retries

Example:

curl -X POST "http://localhost:8000/v0/deployments?tier=performance" \
  -H "Authorization: Bearer $RUNTM_API_KEY" \
  -F "manifest=@runtm.yaml" \
  -F "artifact=@artifact.zip"

Machine Tiers:

All deployments use auto-stop for cost savings (machines stop when idle and start automatically on traffic).

Tier CPUs Memory Est. Cost
starter (default) 1 shared 256MB ~$2/month*
standard 1 shared 512MB ~$5/month*
performance 2 shared 1GB ~$10/month*

*Costs are estimates for 24/7 operation. With auto-stop, costs are much lower for low-traffic services.

Development

# Install dependencies
pip install -e ".[dev]"

# Run migrations
alembic upgrade head

# Start server
uvicorn runtm_api.main:app --reload --host 0.0.0.0 --port 8000

# Run tests
pytest

Environment Variables

Variable Description Default
DATABASE_URL PostgreSQL connection string Required
REDIS_URL Redis connection string Required
RUNTM_API_SECRET API authentication secret (what server validates against) Required
ARTIFACT_STORAGE_PATH Local artifact storage path /artifacts
ARTIFACT_STORAGE_BACKEND Storage backend: local or s3 local
BUCKET_NAME S3/Tigris bucket name (when backend=s3) -
AWS_ENDPOINT_URL_S3 S3 endpoint URL (e.g. https://fly.storage.tigris.dev) -
AUTH_MODE Auth mode: single_tenant or multi_tenant single_tenant

Metadata

Release files for runtm-api 0.2.158

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for runtm-api 0.2.158
File Size Uploaded
runtm_api-0.2.158.tar.gz 66.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for runtm-api 0.2.158
File Interpreter ABI Platform
runtm_api-0.2.158-py3-none-any.whl Python 3 none any Details

Total release size: 128.3 kB

Release files / runtm_api-0.2.158.tar.gz

Download URL runtm_api-0.2.158.tar.gz
Size 66.2 kB
Tags Source
SHA-256 checksum
How to use checksums
d61dac3cf25fbf98299d9c54ac51e3ffe3db9acebd6940b01bfd221a244540a0
BLAKE2b-256 checksum
How to use checksums
9af812d77fd0cfb4fc6b7837b35cbdd6f2e7b3dec78427b0d3cc81fe8181213e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / runtm_api-0.2.158-py3-none-any.whl

Download URL runtm_api-0.2.158-py3-none-any.whl
Size 62.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4f66f864d2915c7ec4f869d8824a938da5c7bba98620f740e870c73e364ce038
BLAKE2b-256 checksum
How to use checksums
ee7db3f5ec909550927e2502c50866ed13d84f0312e01c5a5473eba2d8510dc7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

0.2.158 This release

2 release files

0.2.21

2 release files

0.2.20

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page