Update Prompt — PATCH /api/v1/prompts/{promptId}

Partially update an existing prompt. You only need to include the fields you want to change — any fields you omit remain exactly as they are. This makes it easy to rename a prompt, adjust an aspect ratio, or swap out the model without having to re-send the entire object.

PATCH https://www.promptbank.club/api/v1/prompts/{promptId}

Path Parameters

integer

required

The unique numeric ID of the prompt you want to update.

Request Body

All body fields are optional. Send only what you want to change.

string

Updated display name for the prompt. Must be between 1 and 120 characters.

string

Updated prompt text. Must be between 1 and 15,000 characters.

string

Updated prompt modality. Accepted values: image, text, video.

string

Updated platform label.

string

Updated fal.ai model identifier. Must match ^fal-ai/.+ — for example fal-ai/recraft/v4.1/text-to-image. Required if you are changing promptType to image or video and a modelId is not already set.

string

Updated output aspect ratio, e.g. "16:9". Maximum 20 characters.

integer

Add the prompt to the vault with this ID. To remove a prompt from a vault, use the vault membership endpoint instead.

string

Updated URI for the image associated with this prompt.

array

Replacement array of up to 10 reference media URIs. This overwrites the existing list entirely.

Example Request

curl -X PATCH https://www.promptbank.club/api/v1/prompts/42 \
  -H 'Authorization: Bearer pb_live_...' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Cinematic sunset portrait — golden hour edit",
    "aspectRatio": "16:9"
  }'

Example Response

{
  "data": {
    "id": 42,
    "title": "Cinematic sunset portrait — golden hour edit",
    "prompt": "A cinematic portrait at golden hour, warm tones, shallow depth of field",
    "promptType": "image",
    "platform": "fal.ai",
    "status": "active",
    "images": [],
    "vaultIds": [7],
    "createdAt": "2024-06-01T12:00:00Z",
    "updatedAt": "2024-06-03T08:42:00Z"
  },
  "error": null
}

A successful update returns HTTP 200 OK with the full, updated prompt object. Note that updatedAt reflects the timestamp of this change.

Overview

Prompts

Vaults

Generations

Uploads

API Keys

Update Prompt — PATCH /api/v1/prompts/{promptId}

Path Parameters

Request Body

Example Request

Example Response

​Path Parameters

​Request Body

​Example Request

​Example Response

Path Parameters

Request Body

Example Request

Example Response