Skip to main content
PUT
/
v1
/
prompts
Update Prompt
curl --request PUT \
  --url https://api.getmaxim.ai/v1/prompts \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '{
  "workspaceId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "folderId": "<string>"
}'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "workspaceId": "<string>",
    "accountId": "<string>",
    "folderId": "<string>",
    "meta": "<any>",
    "createdById": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "deploymentHistory": {
      "id": "<string>",
      "workspaceId": "<string>",
      "accountId": "<string>",
      "promptId": "<string>",
      "strategy": {
        "type": "<string>",
        "config": {}
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
workspaceId
string
required

Unique identifier for the workspace

id
string
required

Unique identifier for the prompt

name
string

Name of the prompt

description
string

Description of the prompt

folderId
string | null

Unique identifier for the folder

Response

Prompt updated successfully

data
object
required
I