Skip to main content

​
Overview

The Prompts API allows you to manage reusable conversation templates and AI instructions. These prompts can be used to standardize interactions and ensure consistent AI responses.

​
List Prompts

Get a list of available prompt templates. 
GET /users/:userId/prompts

​
Response

{
  "success": true,
  "data": {
    "prompts": [
      {
        "id": "code-review",
        "name": "Code Review",
        "description": "Review code changes and provide feedback",
        "serverName": "github",
        "arguments": [
          {
            "name": "repository",
            "description": "GitHub repository URL",
            "required": true
          },
          {
            "name": "pullRequest",
            "description": "Pull request number",
            "required": true
          }
        ]
      },
      {
        "id": "data-analysis",
        "name": "Data Analysis",
        "description": "Analyze dataset and provide insights",
        "serverName": "filesystem",
        "arguments": [
          {
            "name": "dataFile",
            "description": "Path to data file",
            "required": true
          }
        ]
      }
    ]
  }
}

​
Get Prompt

Get details of a specific prompt template. 
GET /users/:userId/prompts/:promptId

​
Response

{
  "success": true,
  "data": {
    "prompt": {
      "id": "code-review",
      "name": "Code Review",
      "description": "Review code changes and provide feedback",
      "serverName": "github",
      "arguments": [
        {
          "name": "repository",
          "description": "GitHub repository URL",
          "required": true
        },
        {
          "name": "pullRequest",
          "description": "Pull request number",
          "required": true
        }
      ]
    }
  }
}

​
Create Prompt

Create a new prompt template. 
POST /users/:userId/prompts

​
Request Body

{
  "name": "Bug Analysis",
  "description": "Analyze bug reports and suggest solutions",
  "serverName": "jira",
  "arguments": [
    {
      "name": "issueId",
      "description": "Jira issue ID",
      "required": true
    },
    {
      "name": "severity",
      "description": "Bug severity level",
      "required": false
    }
  ]
}

​
Response

{
  "success": true,
  "data": {
    "prompt": {
      "id": "bug-analysis",
      "name": "Bug Analysis",
      "description": "Analyze bug reports and suggest solutions",
      "serverName": "jira",
      "arguments": [
        {
          "name": "issueId",
          "description": "Jira issue ID",
          "required": true
        },
        {
          "name": "severity",
          "description": "Bug severity level",
          "required": false
        }
      ]
    }
  }
}

​
Execute Prompt

Execute a prompt template with provided arguments. 
POST /users/:userId/prompts/:promptId/execute

​
Request Body

{
  "arguments": {
    "repository": "org/repo",
    "pullRequest": 123
  }
}

​
Response

{
  "success": true,
  "data": {
    "description": "Code review feedback",
    "messages": [
      {
        "role": "assistant",
        "content": {
          "type": "text",
          "text": "I've reviewed the code changes..."
        }
      }
    ]
  }
}