Skip to main content
POST
/
{slug}
/
prompts
Create prompt
curl --request POST \
  --url https://api.dimred.com/api/v2/{slug}/prompts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "project_id": "<string>",
  "name": "<string>",
  "messages": [
    {
      "prompt_text": "<string>",
      "prompt_message_type": "<string>"
    }
  ],
  "input_schema": {},
  "output_schema": {}
}'
{
  "prompt_id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "org_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "messages": [
    {
      "prompt_message_id": "<string>",
      "prompt_text": "<string>",
      "prompt_message_type": "<string>"
    }
  ],
  "input_schema": {},
  "output_schema": {}
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

slug
string
required

Organization slug

Body

application/json
project_id
string
required

Identifier for the project the prompt belongs to

messages
object[]
required

List of prompt messages

name
string

Optional display name for the prompt

input_schema
object

Optional JSON schema for structured input validation

output_schema
object

Optional JSON schema for structured output from LLM

Response

201 - application/json

Prompt created successfully

prompt_id
string
required

Unique identifier for the prompt

project_id
string
required

Identifier for the project the prompt belongs to

created_at
string<date-time>
required

Timestamp when the prompt was created

messages
object[]
required

List of prompt messages

name
string

Optional display name for the prompt

org_id
string

Identifier for the organization

input_schema
object

Optional JSON schema for structured input validation

output_schema
object

JSON schema for structured output from LLM

I