Apply a bulk action to prompts

Base URL: https://{kibana_url}

POST /api/security_ai_assistant/prompts/_bulk_action

Apply a bulk action to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs. This action allows for bulk create, update, or delete operations.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

create object[]: List of prompts to be created.
delete object: Criteria for deleting prompts in bulk.
update object[]: List of prompts to be updated.

Responses

Indicates a successful call with the results of the bulk action.

application/json

attributes object required
message string: A message describing the result of the bulk action.
prompts_count integer: The number of prompts processed in the bulk action.
status_code integer: The HTTP status code of the response.
success boolean: Indicates if the bulk action was successful.

Bad Request response.

application/json

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl \
 --request POST 'http://localhost:5601/api/security_ai_assistant/prompts/_bulk_action' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"delete":{"query":"name: test","ids":[]}}'

Request

Request example

{
  "create": [
    {
      "content": "Please verify the security settings.",
      "name": "New Security Prompt",
      "promptType": "system"
    }
  ],
  "delete": {
    "ids": [
      "prompt1",
      "prompt2"
    ]
  },
  "update": [
    {
      "content": "Updated content for security prompt.",
      "id": "prompt123"
    }
  ]
}

Response

{
  "attributes": {
    "errors": [],
    "results": {
      "created": [
        {
          "content": "Please verify the security settings.",
          "id": "prompt6",
          "name": "New Security Prompt",
          "promptType": "system"
        }
      ],
      "deleted": [
        "prompt2",
        "prompt3"
      ],
      "skipped": [
        {
          "id": "prompt4",
          "name": "Security Prompt",
          "skip_reason": "PROMPT_FIELD_NOT_MODIFIED"
        }
      ],
      "updated": [
        {
          "content": "Updated security settings prompt",
          "id": "prompt1",
          "name": "Security Prompt",
          "promptType": "system"
        }
      ]
    },
    "summary": {
      "failed": 0,
      "skipped": 1,
      "succeeded": 4,
      "total": 5
    }
  },
  "message": "Bulk action completed successfully.",
  "prompts_count": 5,
  "status_code": 200,
  "success": true
}

{
  "error": "Bad Request",
  "message": "Invalid prompt ID or missing required fields.",
  "statusCode": 400
}

Authentication

Request body { }

Responses

Request body