Maxim Logo
Prompts/Deploy

Deploy Prompt Version

Deploy a prompt version

POST
/v1/prompts/deploy

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Request Body

application/jsonOptional
promptIdRequiredstring

Unique identifier for the prompt

versionIdRequiredstring

Unique identifier for the version

workspaceIdRequiredstring

Unique identifier for the workspace

deploymentConditionsRequiredobject

Deployment conditions configuration

curl -X POST "https://api.getmaxim.ai/v1/prompts/deploy" \
  -H "x-maxim-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "promptId": "string",
    "versionId": "string",
    "workspaceId": "string",
    "deploymentConditions": {
      "variable": "string",
      "operator": ">",
      "value": "string"
    }
  }'

Prompt version deployed successfully

{
  "data": {
    "id": "string",
    "promptId": "string",
    "versionId": "string",
    "status": "active",
    "createdAt": "string",
    "updatedAt": "string"
  }
}