v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB
Security AI Assistant API

Get prompts

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/security_ai_assistant/prompts/_find</span></div>

Refer to Spaces for more information.

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

get/api/security_ai_assistant/prompts/_find

Query parameters

fieldsstring[]

List of specific fields to include in each returned prompt.

[
  "id",
  "name",
  "content"
]
filterstring
Example:error handling

Search query string to filter prompts by matching fields.

sort_field'created_at' | 'is_default' | 'name' | 'updated_at'

Field by which to sort the prompts.

Example:created_at

Field to sort prompts by.

sort_order'asc' | 'desc'

The order in which results are sorted.

Example:asc

Sort order, either asc or desc.

pageinteger
Example:1

Page number for pagination.

per_pageinteger
Example:20

Number of prompts per page.

Response

Successful response containing a list of prompts.

pageinteger required

Current page number.

perPageinteger required

Number of prompts per page.

totalinteger required

Total number of prompts matching the query.

Example 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
}