Sign in

v1

latestOpenAPI 3.1.02026-07-136710.4 KB
Prompts

Create Prompt

Endpoint to create a new prompt.

post/prompts/v1/prompts

Request body

teamIdstring nullable

ID of the team that owns this record

createdBystring nullable

ID of the user who created this record

updatedBystring nullable

ID of the user who last updated this record

createdAtstring date-time
updatedAtstring date-time
_idstring nullable

MongoDB document ObjectID

titlestring required

The title of the prompt.

promptstring required

The text/content of the prompt. Can be very long.

dynamicVariablesobject nullable

A dictionary of dynamic variables used in the prompt.

variablesValidationsobject nullable

Variable Validations for dynamic variables in the prompt.

Example request

{
  "teamId": "5eb7cf5a86d9755df3a6c593",
  "createdBy": "5eb7cf5a86d9755df3a6c593",
  "updatedBy": "5eb7cf5a86d9755df3a6c593",
  "_id": "5eb7cf5a86d9755df3a6c593"
}

Response

Successful Response

messagestring

A message indicating the response type.

Example response

{
  "data": {
    "teamId": "5eb7cf5a86d9755df3a6c593",
    "createdBy": "5eb7cf5a86d9755df3a6c593",
    "updatedBy": "5eb7cf5a86d9755df3a6c593",
    "_id": "5eb7cf5a86d9755df3a6c593"
  }
}