Maxim Logo
Prompts

Create Prompt

Create a new prompt

POST
/v1/prompts

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Request Body

application/jsonOptional
workspaceIdRequiredstring

Unique identifier for the workspace

nameRequiredstring

Name of the prompt

descriptionstring

Description of the prompt

folderIdstring

Unique identifier for the folder

curl -X POST "https://api.getmaxim.ai/v1/prompts" \
  -H "x-maxim-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceId": "string",
    "name": "string",
    "description": "string",
    "folderId": "string"
  }'

Prompt created successfully

{
  "data": {
    "data": {
      "id": "string",
      "name": "string",
      "description": "string",
      "workspaceId": "string",
      "accountId": "string",
      "folderId": "string",
      "meta": null,
      "createdById": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string"
    }
  }
}

Get Prompts

Get prompts for a workspace

Update Prompt

Update an existing prompt