Partially Update a Prompt

Partially updates the prompt by its ID

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

prompts:write

Body Request - Example

[
  {
    "op": "REPLACE",
    "path": "/name",
    "value": "helloworld"
  },
  {
    "op": "REPLACE",
    "path": "/description",
    "value": "desc."
  }
]

Body Response - Schema

200 (prompt info)

ParameterTypeDescriptionRequired
idstringthe ID of the promptyes
namestringthe prompt nameyes
descriptionstringthe prompt descriptionyes
asset_idstringasset IDyes
typestringThe prompt type. Allowed values: asset, tts, urlyes
created_atstringthe date when the prompt was createdno
created_bystringthe user who created the promptno
created_user_namestringthe username of the person who created the promptno
updated_atstringthe date when the prompt was updatedyes
updated_bystringthe user who updated the promptyes
updated_user_namestringthe username of the person who updated the promptno
_linksobjectHAL API-related links. "_links" subdivides into:

1 - "self" (object) - link to fetch the detail of the prompt.
1.1 - "href" (string) - address of the resource.

2 - "download_link" (object) - link used to generate a download link (available only when published or archived states).
2.1 - "href" (string) - download link generation address.
yes

401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden), 404 (prompt not found), 422 (unprocessable entity)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!