tAPIstry
Back to docs index

Creator Quickstart

Ready to publish your first API to Tapistry? This guide summarizes the complete creator flow—from signing in and scaffolding a project to pricing, promotion, and monitoring. Prefer Markdown? The full reference lives in docs/guides/CREATOR_QUICKSTART.md.

1. Authenticate the CLI

pnpm add -g @tapistry/cli
tapi login --host https://app.thetapistry.com

Use tapi logout when rotating credentials or switching environments.

2. Scaffold and Configure

tapi init my-first-api --template python-fastapi
cd my-first-api

Update config.yaml with marketplace metadata (title, summary, categories, pricing model, free tier) and verify allowlist.yaml lists every outbound destination your API needs.

3. Implement Code and Tests

Keep Pydantic models strict, redact sensitive outputs, and ensure your tests/ suite covers both success and failure paths—the publish pipeline enforces minimum coverage.

pip install -r requirements.txt
pytest tests/ -v

4. Secure Credentials

Choose between Platform-Managed Keys, Developer-Managed Keys, or User-BYOK. Upload DMK secrets viatapi secrets set or the dashboard under Settings → Secrets, and reference them as environment variables or mounted files.

5. Publish to Edge

tapi publish --channel edge
tapi status my-first-api
tapi logs my-first-api --follow

Builds run containerization, automated tests, security scans, and policy checks. Fix any failures before proceeding.

6. Promote to Stable

tapi promote my-first-api --from edge --to stable
tapi status my-first-api --channel stable

Confirm dependent APIs are still healthy with tapi deps and review contract test results before promotion.

7. Finalize Pricing & Categories

Set pricing, free tiers, and category tags in config.yaml or via the dashboard so consumers can discover and subscribe to your API. Stripe Connect handles payouts once you complete onboarding.

8. Monitor & Iterate

  • Track invocations, latency, and error rates in the analytics dashboard.
  • Subscribe to SLO/alert notifications for regressions.
  • Use audit logs to review security-sensitive events.

Next steps

  • Automate releases in CI with tapi publish --ci.
  • Read the Publish Workflow guide for deeper pipeline details.
  • Share the upcoming Consumer Quickstart with your customers so they can adopt your API faster.