Skip to main content
POST
Run Prompt Version

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
promptId
string
required

Unique identifier for the prompt

versionId
string
required

Unique identifier for the version

workspaceId
string
required

Unique identifier for the workspace

messages
object[]

Array of messages

modelName
string

Name of the model to use

modelProvider
enum<string>

Provider of the model

Available options:
openai,
azure,
huggingface,
anthropic,
together,
google,
groq,
bedrock,
maxim,
cohere,
ollama,
lmstudio,
xai,
vertex,
mistral,
fireworks
modelParameters
object

Model parameters configuration

Response

Prompt version executed successfully

data
object
required