Skip to main content
PUT
/
v1
/
prompts
/
{id}
/
payloads
/
{payloadID}
Update a Prompt Payload
curl --request PUT \
  --url http://localhost:3000/v1/prompts/{id}/payloads/{payloadID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Admin Sample",
  "variables": {
    "user": "Alice",
    "role": "Editor"
  }
}
'
{
  "payload": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "variables": {
      "user": "Arpit",
      "role": "Admin"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use an access token retrieved from login (Bearer sess_...) or a programmatic API key (Bearer ak_...).

Path Parameters

​
id
string<uuid>
required

Unique prompt UUID.

​
payloadID
string<uuid>
required

Unique payload UUID.

Body

application/json
​
name
string

Optional name for this sample payload.

Example:

"Admin Sample"

​
variables
object

JSON object containing variable names and sample values.

Example:
{ "user": "Alice", "role": "Editor" }

Response

Prompt payload updated successfully

​
payload
object
required