GET
/
v1
/
prompts
curl --request GET \
  --url https://api.getmaxim.ai/v1/prompts \
  --header 'x-maxim-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "workspaceId": "<string>",
  "accountId": "<string>",
  "folderId": "<string>",
  "meta": "<any>",
  "createdById": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "deploymentHistory": {
    "id": "<string>",
    "workspaceId": "<string>",
    "accountId": "<string>",
    "promptId": "<string>",
    "strategy": {
      "type": "<string>",
      "config": {}
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Query Parameters

workspaceId
string
required

Unique identifier for the workspace

id
string

Unique identifier for the prompt

name
string

Name of the prompt

limit
number | null
default:10

Maximum number of records to return (max: 100)

Required range: x <= 100
folderId
string

Unique identifier for the folder

includeVersions
boolean | null
default:false

Include prompt versions in the response

cursor
string

Unique identifier for the cursor

Response

200
application/json
Prompts retrieved successfully
id
string
required
name
string
required
description
string
required
workspaceId
string
required
accountId
string
required
folderId
string | null
required
createdById
string
required
createdAt
string
required
updatedAt
string
required
deletedAt
string | null
required
deploymentHistory
object
required
meta
any | null