Launch offer: 50% off.Paid plans only.See pricing
Skip to content
Lamba
Open menu
Get started

Documentation

Reference

OpenAPI and Postman

Use the customer-surface Postman collection and the internal platform OpenAPI exports correctly.

Customer surface Postman collection

  • Collection: backend/lamba/docs/contract/postman/lamba-customer-surface.postman_collection.json
  • Environment: backend/lamba/docs/contract/postman/lamba-customer-test.postman_environment.json
  • Inventory: backend/lamba/docs/contract/postman/lamba-customer-endpoint-inventory.md

Recommended variables:

  • authBaseUrl
  • apiBaseUrl
  • accessToken
  • refreshToken
  • workspaceId
  • projectId
  • environment
  • adminLogin
  • adminPassword

Suggested workflow:

  1. Import the customer collection and test environment.
  2. Set authBaseUrl and apiBaseUrl.
  3. Run Auth - Register or Auth - Password login, then Auth - Switch context.
  4. Use the runnable folders for me/* and admin/*.
  5. Treat the inventory file as the source for manual-only browser or wallet flows.

Notes:

  • This package is customer contract only. It stays on id.* plus api.*.
  • The collection prerequest script removes X-Tenant-Id and X-Project-Id.
  • /v1/admin/* requests do not bootstrap fixtures. They expect sandbox workspaceId, projectId, and an admin-capable user session when needed.
  • Browser-dependent /connect/authorize, social login redirects, and Web3 verification stay out of the runnable collection and are listed under the inventory's manual-only section.
  • Re-generate the customer assets with:
node backend/lamba/scripts/generate-customer-postman.js
node backend/lamba/scripts/generate-customer-postman.js --check

Platform OpenAPI exports

Internal console/app OpenAPI documents stay on platformapi:

curl -fsS https://test.platformapi.uselamba.com/openapi/v1.json -o openapi-platform.json
npx @redocly/cli@latest bundle openapi-platform.json -o openapi-platform.yml

curl -fsS https://test.platformapi.uselamba.com/platform/openapi/v1.json -o openapi-console-bff.json
npx @redocly/cli@latest bundle openapi-console-bff.json -o openapi-console-bff.yml

Customer products should not treat those internal platform documents as the public runtime contract.

Internal console Postman assets also stay on platformapi:

  • Collection: backend/lamba/docs/contract/postman/lamba-console-bff.postman_collection.json
  • Environment: backend/lamba/docs/contract/postman/lamba-console-test.postman_environment.json

Those files are for Lamba console/app flows that still use platformapi plus X-Tenant-Id / X-Project-Id where required. They are not the public customer contract.

Quality gates

  • Keep collection examples in sync with production contracts.
  • Include one happy-path and one error-path example for each critical endpoint group.
  • Use OpenAPI diff checks only for the platformapi surface that actually publishes OpenAPI.

Related docs

  • API overview: /docs/reference/api-overview
  • Plan enforcement: /docs/concepts/plan-enforcement