{"catalogRevision":"cat_f13ab9a494120b5e","recipeId":"page:recipes:rest-api:starlette:artifact-storage","recipeRevision":"r1","canonicalPath":"/recipes/rest-api/starlette/artifact-storage","label":"Host rest api with Starlette: stored input and output artifacts","family":"Workload recipe","summary":"Deploy a rest api built with Starlette on Ample using the generated downloads pattern. Compute runs the app in an isolated microVM behind a public HTTPS URL, a managed PostgreSQL 16 database is auto-provisioned and injected as DATABASE_URL, a private S3-compatible bucket holds objects with credentials delivered as encrypted environment variables. Verified on Starlette: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3). Not separately tested: your export formats, retention policy and entitlement model; treat the rest api-specific behavior as your application code.","representativeQueries":["Host rest api with Starlette: stored input and output artifacts","Where can I host REST API built with Starlette?","I need an input/output artifact contract, object metadata and access boundaries."],"breadcrumbIds":["discovery","workload","workload:agents-and-backends","workload:rest-api","page:recipes:rest-api:starlette:artifact-storage"],"breadcrumbs":[{"id":"discovery","label":"Agent hosting discovery","canonicalPath":"/discover/discovery","kind":"root"},{"id":"workload","label":"Applications and workloads","canonicalPath":"/discover/workload","kind":"facet"},{"id":"workload:agents-and-backends","label":"Agents and backends","canonicalPath":"/discover/workload/agents-and-backends","kind":"group"},{"id":"workload:rest-api","label":"REST API","canonicalPath":"/discover/workload/rest-api","kind":"atom"},{"id":"page:recipes:rest-api:starlette:artifact-storage","label":"Host rest api with Starlette: stored input and output artifacts","canonicalPath":"/recipes/rest-api/starlette/artifact-storage","kind":"recipe"}],"parentIds":["workload:rest-api","stack:framework-starlette","pattern:generated-downloads","intent:deploy-api"],"parents":[{"id":"workload:rest-api","label":"REST API","canonicalPath":"/discover/workload/rest-api","kind":"atom"},{"id":"stack:framework-starlette","label":"Starlette","canonicalPath":"/discover/stack/framework-starlette","kind":"atom"},{"id":"pattern:generated-downloads","label":"Generated downloads","canonicalPath":"/discover/pattern/generated-downloads","kind":"atom"},{"id":"intent:deploy-api","label":"Deploy API","canonicalPath":"/discover/intent/deploy-api","kind":"atom"}],"resourceRequirements":["primitive:compute","primitive:postgres","primitive:s3-compatible-object-storage"],"infrastructureRequirements":[{"primitiveId":"primitive:compute","label":"Compute","canonicalPath":"/discover/primitive/compute","status":"verified","summary":"Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes."},{"primitiveId":"primitive:postgres","label":"Postgres","canonicalPath":"/discover/primitive/postgres","status":"verified","summary":"Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied."},{"primitiveId":"primitive:s3-compatible-object-storage","label":"S3-compatible object storage","canonicalPath":"/discover/primitive/s3-compatible-object-storage","status":"verified","summary":"Buckets are S3-compatible with issued credentials; PutObject and GetObject are verified by canary. Other S3 operations are not verified."}],"framework":"Starlette","workload":"REST API","releaseStatus":"published","supportStatus":"verified","executionStatus":"ready","docsOnly":false,"prerequisites":["A Starlette project that builds and starts with the documented commands (pip install into .ample/python from requirements.txt, then uvicorn from run.py reading PORT on the python-3.12 template)","A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env)","A bucket from `ample bucket create` with its credentials passed as encrypted S3_* environment variables","An Ample account token with servers:write, databases:read, buckets:read"],"testedConfiguration":{"template":"python-3.12","runtime":"python","size":"s-1vcpu-1gb","install":"python3 -m pip install --target .ample/python -r requirements.txt","start":"PYTHONPATH=.ample/python:${PYTHONPATH:-} python3 run.py"},"inputSchema":{"additionalProperties":false,"properties":{"env":{"description":"Encrypted environment variables (bucket credentials, secrets)","items":{"pattern":"^[A-Z][A-Z0-9_]*=.*$","type":"string"},"maxItems":50,"type":"array"},"name":{"description":"App name","maxLength":63,"minLength":1,"pattern":"^[a-z0-9-]+$","type":"string"},"path":{"description":"Project directory or ample.toml service","maxLength":512,"minLength":1,"type":"string"},"release_command":{"description":"Migration command run before activation","maxLength":512,"type":"string"},"start":{"description":"Start command (Python apps pass one explicitly)","maxLength":512,"type":"string"}},"required":["env","name","path","start"],"type":"object"},"outputSchema":null,"workflowSteps":[{"title":"Build and start","body":"pip install into .ample/python from requirements.txt, then uvicorn from run.py reading PORT on the python-3.12 template. The server must bind 0.0.0.0 on PORT."},{"title":"Implement the pattern on PostgreSQL","body":"The fixture's module implements generated downloads: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3). Copy the approach into your schema; keep migrations idempotent and run them with --release-command."},{"title":"Wire object storage","body":"Create the bucket(s), then pass endpoint, region, bucket and keys as --env values. Use path-style addressing. Keep private data in an unpublished bucket."},{"title":"Deploy","body":"Run the synchronous deploy once and read the result (exit 0 live, 1 failed, 2 blocked). Re-running with no change is a no-op.","command":"ample deploy . --name <app-name> --public --start \"python3 run.py\" --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=..."},{"title":"Verify","body":"Fetch the live URL and the pattern self-test route(s) (/p/generated-downloads) from the example; then run your own checks. On failure read `ample logs <deployment_id> --kind build` then `--kind runtime`.","command":"ample logs <deployment_id> --kind build"}],"examples":[{"title":"Starlette pattern fixture","description":"Multi-pattern Starlette app whose generated downloads module was checked live; the module is under tests/deploy-canaries/_pattern-modules.","sourceRef":"tests/deploy-canaries/starlette-patterns"}],"successChecks":[{"description":"app responds on its public URL","kind":"http_get","path":"/","expect":"ample canary starlette patterns"},{"description":"generated-downloads self-test","kind":"http_get","path":"/p/generated-downloads","expect":"export=ok rows=3 (with ?token=...; 401 without)"}],"limitations":["Verified on the python-3.12 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Starlette major versions are not verified.","The rest api itself (your export formats, retention policy and entitlement model) is application code and was not separately tested; the pattern checks are what was verified.","Region, compliance attestations and request-duration limits are unknown and not claimed.","Apps auto-pause when idle and wake on the next request; always-on is an operator setting, not a plan feature.","Managed PostgreSQL 16 only; extensions, connection limits and backup or restore procedures are not verified; apps and their databases are placed together.","PutObject and GetObject with path-style addressing are verified; multipart upload, listing, presigned URLs and lifecycle rules are not."],"costEstimate":{"currency":"USD","monthlyAmount":10.0,"authoritative":true,"basis":"size prices from pricing.toml (loaded by the API) at build revision 0c958eb34fa2adbf8e036129268257aa92e78ee7","components":[{"name":"app server","size":"s-1vcpu-1gb","quantity":1.0,"monthlyAmount":5.0},{"name":"managed PostgreSQL database","size":"s-1vcpu-1gb","quantity":1.0,"monthlyAmount":5.0}],"note":"Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included."},"evidenceSummary":[{"kind":"canary_run","summary":"Starlette pattern fixture deployed on Ample (pip install into .ample/python from requirements.txt, then uvicorn from run.py reading PORT on the python-3.12 template); checks passed for generated-downloads and configuration-secrets. Pattern proof: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3).","observedAt":"2026-09-21T01:21:36Z","implementationRevision":"50dbac567d2c5cc8e55e6c748a646be0025d9cfb (CLI 0.1.21)","expiresAt":"2027-03-20T01:21:36Z","scope":{"checks":["/p/generated-downloads"],"pattern":"pattern:generated-downloads","template":"python-3.12"}},{"kind":"canary_run","summary":"The same Starlette app deployed with a --release-command migration; the marker it created was readable after activation.","observedAt":"2026-09-20T02:16:51Z","implementationRevision":"199ff1dfd52683832ae75d3f98b53a7a4bff7f96 (CLI e3181f5)","expiresAt":"2027-03-19T02:16:51Z","scope":{"pattern":"pattern:generated-downloads"}}],"lastVerifiedAt":"2026-09-21T01:21:36Z","mcpBinding":{"registryRef":"mcp:ample_deploy","toolName":"ample_deploy","schemaHash":"876465fce906da0c224d62961d3343064108ebe30af80cf1b87094974e948853","observedAt":"2026-09-22T00:31:22.774679+00:00","implementationRevision":"e6446ceea69b","requiredScopes":["servers:write","databases:read","buckets:read"],"bindingState":"current"},"unknowns":["region availability is unknown until a verified region fact is recorded","compliance attestations are unknown; none are claimed"],"formats":{"html":"https://ample.computer/recipes/rest-api/starlette/artifact-storage","markdown":"https://ample.computer/recipes/rest-api/starlette/artifact-storage.md","json":"https://api.ample.computer/v1/catalog/recipes/page%3Arecipes%3Arest-api%3Astarlette%3Aartifact-storage"},"nextActions":[{"actionId":"browse-catalog","label":"Browse the catalog index","operationId":"catalog_index","method":"GET","relativePath":"/v1/catalog","origin":"api","parameters":{},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"search-recipes","label":"Search published recipes by intent, stack and constraints","operationId":"search_recipes","method":"POST","relativePath":"/v1/catalog/search","origin":"api","parameters":{"body":{"limit":5,"query":"Host rest api with Starlette: stored input and output artifacts"}},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"plan:page:recipes:rest-api:starlette:artifact-storage","label":"Prepare a side-effect-free deployment plan for an authorized project","operationId":"plan_deployment","method":"POST","relativePath":"/v1/catalog/plan","origin":"api","parameters":{"body":{"inputs":{},"projectId":"<workspace or server id you own>","recipeId":"page:recipes:rest-api:starlette:artifact-storage","recipeRevision":"r1"}},"requiresAuthentication":true,"requiresApproval":false},{"actionId":"auth-setup","label":"Read the existing agent authentication setup","operationId":"existing_auth_setup","method":"GET","relativePath":"/mcp/setup","origin":"api","parameters":{},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:workload:rest-api","label":"Browse REST API","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/workload%3Arest-api","origin":"api","parameters":{"nodeId":"workload:rest-api"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:stack:framework-starlette","label":"Browse Starlette","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/stack%3Aframework-starlette","origin":"api","parameters":{"nodeId":"stack:framework-starlette"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:pattern:generated-downloads","label":"Browse Generated downloads","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/pattern%3Agenerated-downloads","origin":"api","parameters":{"nodeId":"pattern:generated-downloads"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:intent:deploy-api","label":"Browse Deploy API","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/intent%3Adeploy-api","origin":"api","parameters":{"nodeId":"intent:deploy-api"},"requiresAuthentication":false,"requiresApproval":false}]}