Access Swagger

You can access documentation for the Streaming Writer API via a Swagger interface. 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.

Alternatively access the Portal to determine the Swagger URL

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

  2. Select the "Write" tab (this is the default).

  3. Select the HTTP language option language http

You will see a Swagger URL specific to your workspace and the code panel on the right will show example code including a bearer token.