Skip to main content
POST
Create a prompt

Authorizations

Authorization
string
header
required

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

Body

application/json
display_name
string
required

The prompt’s name, meant to be displayable in the UI.

Maximum string length: 128
prompt
PromptInput · object
required

Prompt configuration with model and messages.

Example:
path
string
required

Entity storage path.

With workspace-level API keys, use the format project/folder/subfolder/.... The first element identifies the project, followed by nested folders (auto-created as needed). Example: Default/agents.

With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: agents. For backward compatibility, a leading project name is ignored when it matches the scoped project.

Example:

"Default"

description
string | null

The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose

metadata
object

Response

200 - application/json

Prompt created.

A prompt entity with configuration, metadata, and versioning.

_id
string
required
type
enum<string>
required
Available options:
prompt
owner
string
required
domain_id
string<uuid>
required
created
string
required
updated
string
required
display_name
string
required

The prompt’s name, meant to be displayable in the UI.

Maximum string length: 128
prompt
PromptField · object
required

Prompt configuration with model and messages. Use this instead of prompt_config.

created_by_id
string<uuid> | null
updated_by_id
string<uuid> | null
description
string | null

The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose

prompt_config
object
deprecated

[DEPRECATED] Use the prompt property instead. A list of messages compatible with the openAI schema.

metadata
object