Get Prompts

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Query Parameters

workspaceIdRequiredstring

Unique identifier for the workspace

idstring

Unique identifier for the prompt

namestring

Name of the prompt

limitnumber

Maximum number of records to return (max: 100)

Default: 10Maximum: 100

folderIdstring

Unique identifier for the folder

includeVersionsboolean

Include prompt versions in the response

Default: false

cursorstring

Unique identifier for the cursor

curl -X GET "https://api.getmaxim.ai/v1/prompts?workspaceId=%3Cstring%3E&id=%3Cstring%3E&name=%3Cstring%3E&limit=10&folderId=%3Cstring%3E&includeVersions=false&cursor=%3Cstring%3E" \
  -H "x-maxim-api-key: <token>"

Prompts retrieved successfully

{
  "id": "string",
  "name": "string",
  "description": "string",
  "workspaceId": "string",
  "accountId": "string",
  "folderId": "string",
  "meta": null,
  "createdById": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "deletedAt": "string",
  "deploymentHistory": {
    "id": "string",
    "workspaceId": "string",
    "accountId": "string",
    "promptId": "string",
    "strategy": {
      "type": "string",
      "config": {
        "property1": [
          {
            "id": "string",
            "rules": {
              "query": {
                "not": true,
                "rules": [
                  {
                    "field": "string",
                    "value": "string",
                    "operator": "string",
                    "valueSource": "string"
                  }
                ],
                "combinator": "string"
              },
              "version": 0
            },
            "timestamp": "string"
          }
        ],
        "property2": [
          {
            "id": "string",
            "rules": {
              "query": {
                "not": true,
                "rules": [
                  {
                    "field": "string",
                    "value": "string",
                    "operator": "string",
                    "valueSource": "string"
                  }
                ],
                "combinator": "string"
              },
              "version": 0
            },
            "timestamp": "string"
          }
        ]
      }
    },
    "createdAt": "string",
    "updatedAt": "string",
    "deletedAt": "string"
  }
}

Authorization

Query Parameters

Response

TypeScript