Skip to main content
PUT
/
api
/
v1
/
prompts
/
{prompt_id}
{
  "id": "<string>",
  "text": "<string>",
  "type": "SYSTEM",
  "version": 123,
  "status": "ACTIVE",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
prompt_id
string
required

Body

application/json
​
text
string | null

The text content of the prompt

Minimum string length: 1
​
type
enum<string> | null

Type of the prompt (System or Human)

Available options:
SYSTEM,
HUMAN
​
status
enum<string> | null

Status of the prompt (active or inactive)

Available options:
ACTIVE,
INACTIVE

Response

Successful Response

​
id
string
required

Unique identifier of the prompt

​
text
string
required

The text content of the prompt

​
type
enum<string>
required

Type of the prompt (System or Human)

Available options:
SYSTEM,
HUMAN
​
version
integer
required

Version number of the prompt

​
status
enum<string>
required

Status of the prompt (active or inactive)

Available options:
ACTIVE,
INACTIVE
​
created_at
string<date-time>
required

Timestamp of when the prompt was created

​
updated_at
string<date-time>
required

Timestamp of when the prompt was last updated

​
created_by
string | null

ID of the user who created the prompt