curl --request POST \
--url https://api.getmaxim.ai/v1/prompts/versions \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"promptId": "<string>",
"description": "<string>",
"modelName": "<string>",
"modelProvider": "openai",
"messages": [
{
"role": "assistant",
"content": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
]
}
],
"modelParameters": {}
}
'{
"data": {
"id": "<string>",
"version": 123,
"description": "<string>",
"promptId": "<string>",
"config": {
"model": "<string>",
"author": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>"
},
"messages": [
{
"id": "<string>",
"index": 123,
"payload": {
"role": "<string>",
"content": "<string>"
},
"currentType": "<string>",
"originalType": "<string>"
}
],
"provider": "<string>",
"modelParameters": {
"top_p": 123,
"max_tokens": 123,
"promptTools": [
null
],
"temperature": 123,
"image_detail": {
"detail": "<string>"
},
"response_format": {
"type": "<string>"
},
"frequency_penalty": 123
}
},
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}Create a prompt version
curl --request POST \
--url https://api.getmaxim.ai/v1/prompts/versions \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"promptId": "<string>",
"description": "<string>",
"modelName": "<string>",
"modelProvider": "openai",
"messages": [
{
"role": "assistant",
"content": "<string>",
"tool_call_id": "<string>",
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
]
}
],
"modelParameters": {}
}
'{
"data": {
"id": "<string>",
"version": 123,
"description": "<string>",
"promptId": "<string>",
"config": {
"model": "<string>",
"author": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>"
},
"messages": [
{
"id": "<string>",
"index": 123,
"payload": {
"role": "<string>",
"content": "<string>"
},
"currentType": "<string>",
"originalType": "<string>"
}
],
"provider": "<string>",
"modelParameters": {
"top_p": 123,
"max_tokens": 123,
"promptTools": [
null
],
"temperature": 123,
"image_detail": {
"detail": "<string>"
},
"response_format": {
"type": "<string>"
},
"frequency_penalty": 123
}
},
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}Documentation Index
Fetch the complete documentation index at: https://www.getmaxim.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
API key for authentication
Prompt identifier
Version description
Name of the model
Provider of the model
openai, azure, huggingface, anthropic, together, google, groq, bedrock, maxim, cohere, ollama, xai, vertex, mistral, fireworks Array of messages
Show child attributes
Model parameters including prompt tools
Show child attributes
Prompt version created successfully
Show child attributes
Was this page helpful?