Skip to main content
GET
/
api
/
v1
/
prompts
List prompts for a project
curl --request GET \
  --url https://app.dimred.com/api/v1/prompts \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "prompt_message_id": "<string>",
    "project_id": "<string>",
    "prompt_message_type": "system",
    "prompt_text": "<string>",
    "input_schema": {},
    "output_schema": {},
    "prompt_source": "<string>",
    "prompt_source_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

API key for authentication. Obtain from your DimRed dashboard. The organization context is automatically derived from the API key.

Query Parameters

​
project_id
string
required

Project identifier

Response

Prompts retrieved successfully

​
id
string

Unique identifier for the prompt

​
prompt_message_id
string

Message identifier

​
project_id
string

Project identifier

​
prompt_message_type
enum<string>

Type of the message

Available options:
system,
user,
assistant
​
prompt_text
string

Content of the prompt

​
input_schema
object | null

JSON schema for input validation

​
output_schema
object | null

JSON schema for structured output

​
prompt_source
string | null

Source of the prompt

​
prompt_source_id
string | null

Source identifier

​
created_at
string<date-time>

ISO 8601 timestamp of creation