Sign in

v1

latestOpenAPI 3.1.02026-08-06213193627.0 KB
playground

Get Playground Prompt Request

In a similar way to our /v1/chat_completions endpoint, this endpoint is used (unauthenticated) to store Playground requests in the database. The endpoint returns the created log, and Frontend handles the data.

post/v1/playground/chat

Request body

promptstring required

The user prompt

modelstring nullable

The name of the model which will be used

temperaturenumber nullable

The temperature of the request

max_tokensinteger nullable

The maximum number of tokens for the request

app_idstring uuid required

The App ID belonging to this user's org where all the logs will be logged

assistant_idstring uuid nullable

The Assistant ID to use for this request

assistant_version_idstring uuid nullable

The Assistant version ID to use for this request

conversation_idstring uuid nullable

The Conversation ID to use for this request

parent_request_idstring uuid nullable

The Parent Request ID to use for this request

pluginsstring[]

The list of plugins to enable for the request

imagesstring[] nullable

A list of images that should be analyzed (vision api)

filesstring[] nullable

A list of files that should be analyzed (images, audio, etc.)

Response

Successful Response