Get prompts

Base URL: https://{kibana_url}

GET /api/security_ai_assistant/prompts/_find

Auth

Get a list of all prompts based on optional filters, sorting, and pagination.

Query parameters

fields string[]: List of specific fields to include in each returned prompt.; Example: ["id","name","content"]
filter string: Search query string to filter prompts by matching fields.; Example: error handling
sort_field enum: Field to sort prompts by.; Values: created_at is_default name updated_at
sort_order enum: Sort order, either asc or desc.; Values: asc desc
page integer · min: 1 · default: 1: Page number for pagination.
per_page integer · min: 0 · default: 20: Number of prompts per page.

Responses

Successful response containing a list of prompts.

application/json

data object[] required: The list of prompts returned based on the search query, sorting, and pagination.
page integer required: Current page number.
perPage integer required: Number of prompts per page.
total integer required: Total number of prompts matching the query.

Bad request due to invalid parameters or malformed query.

application/json

error string: Short error message.
message string: Detailed description of the error.
statusCode number: HTTP status code for the error.

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl \
 --request GET 'http://localhost:5601/api/security_ai_assistant/prompts/_find?page=1&per_page=20' \
 --header "Authorization: $API_KEY"

Response

{
  "data": [
    {
      "categories": [
        "troubleshooting",
        "logging"
      ],
      "color": "#FF5733",
      "consumer": "security",
      "content": "If you encounter an error, check the logs and retry.",
      "createdAt": "2025-04-20T21:00:00Z",
      "createdBy": "jdoe",
      "id": "prompt-123",
      "isDefault": true,
      "isNewConversationDefault": false,
      "name": "Error Troubleshooting Prompt",
      "namespace": "default",
      "promptType": "standard",
      "timestamp": "2025-04-30T22:30:00Z",
      "updatedAt": "2025-04-30T22:45:00Z",
      "updatedBy": "jdoe",
      "users": [
        {
          "full_name": "John Doe",
          "username": "jdoe"
        }
      ]
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 142
}

{
  "error": "Bad Request",
  "message": "Invalid sort order value provided.",
  "statusCode": 400
}