tAPIstry
Back to docs index

Consumer Quickstart

Use this walkthrough to discover marketplace APIs, mint platform keys, and invoke endpoints while keeping billing predictable. For the Markdown source, open docs/guides/CONSUMER_QUICKSTART.md.

1. Discover APIs

Log into the Tapistry dashboard and browse Marketplace by category, pricing, or publisher. Each listing summarizes free tiers, per-call rates, and SLO expectations so you can choose the right integration.

curl https://api.thetapistry.com/apis/marketplace   | jq '.[] | {name, slug, pricing_model, free_tier_calls}'

2. Create a Platform Key

Platform keys authorize calls to any API you are allowed to consume. Generate them under Settings → Keysfor each environment. Keys can also be listed programmatically:

curl -H "Authorization: Bearer $TOKEN"   https://api.thetapistry.com/auth/keys | jq '.keys'

3. Invoke with “One Key, Many APIs”

The same key works across multiple APIs. Supply it via the X-Platform-Key header and include the target environment in the payload.

curl -X POST https://api.thetapistry.com/invoke/weather-forecast   -H "X-Platform-Key: pk_prod_abc123"   -H "Content-Type: application/json"   -d '{
        "env": "prod",
        "payload": {
          "location": "San Francisco, CA",
          "units": "metric"
        }
      }'

Responses include quota and billing metadata so you can track spend per call.

4. Know the Billing Rules

  • Free: requests are free until free-tier calls are consumed.
  • Per-call: each success bills the published price; free tiers still apply.
  • Subscription: requires an active Stripe subscription or invocations return HTTP 402.

Monitor Dashboard → Usage & Billing for aggregate charges and quota alerts.

5. Troubleshooting

  • HTTP 401: regenerate the platform key—previous token likely revoked.
  • HTTP 403 with quota messaging: upgrade your plan or wait for quotas to reset.
  • HTTP 402: finish subscription checkout from the marketplace listing.

What’s Next?

  • Review the API Reference for endpoint schemas.
  • Share feedback with creators using marketplace discussions.
  • Track invoices under Billing → Statements.