v47

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2024-10-01163166522.3 KB

Prompts

Create prompt

Create a new prompt. If there is an existing prompt in the project with the same slug as the one specified in the request, will return the existing prompt unmodified

post/v1/prompt

Request body

project_idstring uuid required

Unique identifier for the project that the prompt belongs under

namestring required

Name of the prompt

slugstring required

Unique identifier for the prompt

descriptionstring nullable

Textual description of the prompt

tagsstring[] nullable

A list of tags for the prompt

function_type'llm' | 'scorer' | 'task' | 'tool' | 'null' nullable

Response

Returns the new prompt object

idstring uuid required

Unique identifier for the prompt

_xact_idstring required

The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the prompt (see the version parameter)

project_idstring uuid required

Unique identifier for the project that the prompt belongs under

log_id'p' required

A literal 'p' which identifies the object as a project prompt

org_idstring uuid required

Unique identifier for the organization

namestring required

Name of the prompt

slugstring required

Unique identifier for the prompt

descriptionstring nullable

Textual description of the prompt

createdstring date-time nullable

Date of prompt creation

tagsstring[] nullable

A list of tags for the prompt

metadataobject nullable

User-controlled metadata about the prompt

function_type'llm' | 'scorer' | 'task' | 'tool' | 'null' nullable