---
updatedAt: 2026-05-28T16:34:14.000Z
agentTools:
  projectIndex: https://docs.nebulock.io/llms.txt
---

# Generate hunt suggestions

Generate hunt suggestions based on threat intelligence context.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Hunt API",
    "description": "Hunt-domain external API. Authenticate with API key credentials (`X-API-Key-ID` and `X-API-Key-Secret` headers on each request).",
    "version": "0.0.1"
  },
  "paths": {
    "/public/v1/hunt-suggestions": {
      "post": {
        "tags": [
          "hunt"
        ],
        "summary": "Generate hunt suggestions",
        "description": "Generate hunt suggestions based on threat intelligence context.",
        "operationId": "generate_hunt_suggestions_public_v1_hunt_suggestions_post",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExternalGenerateHuntSuggestionsRequest"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalHuntSuggestionJobResponse"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          },
          {
            "ApiKeySecretAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ExternalGenerateHuntSuggestionsRequest": {
        "properties": {
          "count": {
            "type": "integer",
            "title": "Count",
            "default": 3
          },
          "threatIntelId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Threatintelid"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "title": "ExternalGenerateHuntSuggestionsRequest"
      },
      "ExternalHuntSuggestionDetailResponseData": {
        "properties": {
          "suggestionId": {
            "type": "string",
            "format": "uuid",
            "title": "Suggestionid"
          },
          "jobId": {
            "type": "string",
            "format": "uuid",
            "title": "Jobid"
          },
          "contextId": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ],
            "title": "Contextid"
          },
          "organizationId": {
            "type": "string",
            "title": "Organizationid"
          },
          "userId": {
            "type": "string",
            "title": "Userid"
          },
          "title": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Title"
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description"
          },
          "directive": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Directive"
          },
          "reasoning": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Reasoning"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "title": "Createdat"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Updatedat"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "suggestionId",
          "jobId",
          "contextId",
          "organizationId",
          "userId",
          "title",
          "description",
          "directive",
          "reasoning",
          "createdAt",
          "updatedAt"
        ],
        "title": "ExternalHuntSuggestionDetailResponseData"
      },
      "ExternalHuntSuggestionJobResponse": {
        "properties": {
          "data": {
            "$ref": "#/components/schemas/ExternalHuntSuggestionJobResponseData"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "data"
        ],
        "title": "ExternalHuntSuggestionJobResponse"
      },
      "ExternalHuntSuggestionJobResponseData": {
        "properties": {
          "jobId": {
            "type": "string",
            "format": "uuid",
            "title": "Jobid"
          },
          "organizationId": {
            "type": "string",
            "title": "Organizationid"
          },
          "userId": {
            "type": "string",
            "title": "Userid"
          },
          "status": {
            "type": "string",
            "title": "Status"
          },
          "suggestions": {
            "items": {
              "$ref": "#/components/schemas/ExternalHuntSuggestionDetailResponseData"
            },
            "type": "array",
            "title": "Suggestions"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "title": "Createdat"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Updatedat"
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "jobId",
          "organizationId",
          "userId",
          "status",
          "suggestions",
          "createdAt",
          "updatedAt"
        ],
        "title": "ExternalHuntSuggestionJobResponseData"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key-ID",
        "description": "Your API Key ID"
      },
      "ApiKeySecretAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key-Secret",
        "description": "Your API Key Secret"
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "ApiKeySecretAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.nebulock.io",
      "description": "Production"
    }
  ]
}
```