Docs

The desktop

Playground

The desktop app for the catalogue — every model as a form, your runs of it, and the request each one sends.

Playground is the desktop app for the catalogue. It has two places: Model, the catalogue itself, under All models and each category down the rail on the left, and Generate, the form of the model you picked. Everything you made, in every app, is in the Library. On a phone Playground is under More.

#Model

The catalogue, by category. Each model's page says what it makes, what it costs and whether it runs now; a model that is described but not yet connected has a form you can fill and a Generate button that is off, with the reason under it — the same 501 model_not_connected a submit would answer.

#Generate

The form for the model you picked, drawn from the address's own contract — the same components.schemas.Input that /v1/models/<address>/openapi.json serves. Every control maps to one field: a chooser for an enum, a switch for a boolean, a number box that sends a number, a URL field with Upload a file beside it for an image, a track or a mesh.

The header switches between two pages:

  • Generate — the form on the left and the workbench on the right, whose tabs are Result (the answer as it arrives, drawn by what the output is), Examples (worked examples you can load into the form), Pricing, and Your runs.
  • API — the same request as curl, Python and JavaScript, addressed to queue.auray.run/<address>, rewritten as you change the form. No key is printed; $AURAY_API_KEY stands where yours goes.

#Your form

Each model keeps one form, and it is the same form in Playground and in the app that runs the model. It is saved to your account as you type, so it is there after a reload and when you open it on another device. The line under Generate says what the account's copy is doing: Saving to your account…, Saved to your account, Could not reach your account when a save did not go through (it is tried again), or On this device only for a form too large to keep in your account, or one your account no longer holds.

If the form was changed on another device, a banner over it asks which version to keep before anything is saved: Keep what's on screen saves yours over the other, and Load the other version loads it and offers Restore my version under the form. A file you uploaded into it comes back for as long as uploads are kept; a pasted link is not kept, and the form says which field held one. Reset empties the account's copy too. A form nobody has touched for 3 days is deleted from your account, as every draft is; a device that already had it keeps its own copy, says it is on this device only, and saves it to your account again when you next change it.

#Language models

A language model's page is a conversation rather than a form: a system prompt, the next message and the model's settings on the left, the transcript in the workbench's Result tab. It sends the same request /openai/v1/chat/completions takes, and it has no Examples tab.

#Your runs

Every job this account has run on the model — from Playground, from an app, or through the API, which are marked API — with its status, its time and what it cost. Opening one puts it back on the Result tab without running anything.

#Stopping

A catalogue model's job cannot be stopped once it starts. The button beside a running job says Stop watching, which is what it does — the job finishes and is charged for what it delivers. A job you were watching when you reloaded is watched again.

#Uploading an input

Upload a file beside a URL field does the three calls Uploads describes: asks the API for somewhere to put the file, puts the bytes there directly, and fetches the signed read URL that goes into the field. A field the model only accepts as a file part says so and names the _url field to use instead.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close