Input schema and field types

An Input Schema describes what data someone must send to use your API. Imagine your API provides weather data – it probably needs a city and maybe a date. That's exactly what you enter here.

For each parameter you define:

• a name (e.g. city or date),
• a type (e.g. Text for a city or Date for a date),
• whether it is required (Required).

This way both people and programs know exactly what to send to your API. An Output Schema works the same way – it just describes what your API returns (e.g. temperature as a number).

If you are technical you can switch the form to Enter JSON directly and specify the schema yourself in JSON format.

Field Types

When describing your inputs and outputs you choose a type for each parameter. The type specifies what kind of value is expected. Here are the most important:

• Text – for words or sentences, e.g. a city name like Hamburg.
• Number – for numeric values, e.g. a temperature (21) or a price.
• Date – for a calendar date, e.g. 2025-06-16.
• Boolean (Yes/No) – for simple true/false values, e.g. active: yes.
• Email — for an email address. The gateway does not check the format.
• URL – for a web address, e.g. https://….

Choose the type that best fits your parameter. When in doubt, Text is always a safe choice.