Prompt Payloads

Update a Prompt Payload

Changed on

Updates an existing sample payload's variables and/or optional name. Only editors can update.

put/v1/prompts/{id}/payloads/{payloadID}

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/v1/prompts/{id}/payloads/{payloadID}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Unique prompt UUID.

payloadIDstring uuid required

Unique payload UUID.

Request body

namestring

Optional name for this sample payload.

variablesobject

JSON object containing variable names and sample values.

Example request

{
  "name": "Admin Sample",
  "variables": {
    "user": "Alice",
    "role": "Editor"
  }
}

Response

Prompt payload updated successfully

Example response

{
  "payload": {
    "variables": {
      "user": "Arpit",
      "role": "Admin"
    }
  }
}

Changes