Developer Preview

Velo is always in active development, and we're constantly adding new APIs. We want to make sure that we're on the right track and building the functionality that you need. For this reason, we release some of the APIs we're still working on in Developer Preview mode for user testing. This is a way for us to get feedback from you and improve our APIs before we fully release them.

APIs in Developer Preview mode include the following warning in their introductions:

Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.

They also include this tag in the reference for each function:

Once these tags are removed, the API is fully released.

Here is some important information to know about Developer Preview:

Breaking changes

APIs in Developer Preview are still in development. This means that we may change them at any time. Notifications about breaking changes appear in the release notes and in the API reference for the affected functions and properties. We will not contact you directly about breaking changes.

Because we may introduce breaking changes to these APIs, you shouldn't use them on live sites. They are for testing and feedback purposes only.

Time limit

APIs only stay in Developer Preview mode for a maximum of 6 months. After that they are fully released, and we don't make any breaking changes to them.

You can see which APIs are in Developer Preview in the table below. You can also check the API documentation in the reference to see if the developer preview tags have been removed.

Feedback

We would appreciate your feedback on the APIs in Developer Preview. Let us know about:

  • What you're using the API for.
  • Anything blocking you from using the API.
  • Additions and features you would find useful.

Please email us with your feedback.

Bugs

If you discover a bug in a Developer Preview API, please email us and let us know. We'll fix the bug as soon as possible.

Did this help?