đQuickstart
Last updated
Last updated
Create an account if you haven't already on our Web App.
See Creating a Space to learn more about creating a Space to get started. You'll need one going forward in the Quickstart.
To get started and always have a quick reference, we've created an example API for you to clone into your Space through our API template marketplace.
After cloning the Examples API, navigate to our first example, "Ex0: Hello World". This is the most basic endpoint, returning a singular static reply.
The "Connect" tab gives an overview of connections to this endpoint and describes how to invoke the endpoint from our TypeScript SDK.
The "Endpoint" tab is the editor for creating the endpoint Handler. This script is what gets executed whenever this endpoint is invoked.
The "Test" tab enables you to test your endpoint through the TypeScript SDK. It won't do everything the SDK can (two-way data streaming for example), but is very helpful for quick iterations and API development.
The "Reference" endpoint in the "Examples" API outlines every single field that can be defined in a Handler. We make this a part of the example API to make it easy for you to reference while developing.
This endpoint won't update automatically, so if you're curious about updates, go back to the marketplace and update the "Examples" API with the most recent version. We'll send out product updates and update this API as needed. Please don't hesitate to contact us (or Slack me) with questions, ideas, issues, etc...
Take a look at the other example API endpoints in the "Examples" API. It outlines examples for all of the cool things you can do with Formata.
Have fun creating APIs! And contact us (or Slack me) with any questions, issues, ideas, etc... that come up as you use Formata.
On the Marketplace tab, filter for "Formata" to see the APIs Formata provides (many more to come). Look for the "Examples" API, click "More Info", and then "Clone". This will copy our Examples API into your Space and will now be your Examples API.
