SUTRA / DOCUMENTATION
Your first API workflow.
One step at a time.
A practical guide to the hosted workspace. Start with a small API and test data you can safely experiment with.
STEP 01
Create your workspace.
Create an account, then open the dashboard. Use a separate project or test API while learning the workflow. If you already have an account, log in here.
STEP 02
Scan source or import a specification.
Choose the repository scanning flow to discover supported route patterns from code. If you already have an OpenAPI document, use the import flow: paste its contents, upload a file, or provide its URL.
For a first pass, use a small service with a few read-only endpoints. Review the import result; dynamic routes and unusual framework patterns may need manual attention.
Understand the catalog →STEP 03
Read the API before publishing it.
Open the discovered endpoints and inspect their methods, paths, parameters, descriptions, and response schemas. Give each operation a useful description so a developer or agent can tell when to use it.
- Are required parameters correctly identified?
- Are response types useful and complete?
- Is authentication documented?
- Are quality findings understood?
STEP 04
Define a consumer’s view.
Create an API contract, choose its audience, and select the endpoints that audience needs. Review field rules to keep, mask, or remove response fields. Check the proposed surface before approving and publishing it.
Begin with one audience and one workflow. A partner that retrieves a payment probably does not need a customer deletion tool.
Explore contract boundaries →STEP 05
Publish, install, and verify.
Open the MCP server associated with your collection or contract. Review visibility and upstream authentication settings. Use the server’s install page for the actual URL and client configuration; keep private keys out of public channels.
Connect a client that supports those transport and authentication settings. List the tools and try a read-only call with test data. Use the playground and call history to investigate errors.