Access Swagger

You can access documentation and a basic playground for the Streaming Writer API via Swagger. The exact URL is workspace-specific, and follows this pattern:

https://writer-${organisation}-${workspace}.platform.quix.ai/

The workspace ID is a combination based on your organisation and workspace names. For example, for an "acme" organisation with a "weather" workspace, the final URL might look something like:

https://writer-acme-weather.platform.quix.ai/

To determine the final URL, you can find out how to get a workspace id, or follow these instructions:

  1. Click the Library icon Library in the main menu.

  2. Search for "HTTP API - Shell Script" item in the search bar and select the item.

  3. Find in the Code Preview the Url on any of the POST methods of the sample.