> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cotool.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get async SIEM query generation status

> Returns the current status of a background detection query generation job.



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json get /api/detection-queries/generate-async/{jobId}
openapi: 3.1.0
info:
  title: Cotool API
  version: 1.0.0
  description: >-
    # Cotool API Documentation


    The Cotool API allows you to interact with the Cotool platform
    programmatically, enabling you to build powerful integrations and automate
    your workflows.


    ## Getting an API Key


    Follow these steps to generate your API key:


    1. **Log in** to the Cotool web interface

    2. **Navigate** to `/settings/api-keys`

    3. **Click** "Generate Key"

    4. **Copy and store** your API key securely ⚠️ *It won't be shown again*


    ## API Key Authentication


    For programmatic access and integrations, use your API key with the
    Authorization header:


    ```http

    Authorization: Bearer your_api_key_here

    ```


    ```bash

    curl -X GET "https://app.cotool.ai/api/endpoint" \
      -H "Authorization: Bearer your_api_key_here" \
      -H "Content-Type: application/json"
    ```
servers:
  - url: https://app.cotool.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /api/detection-queries/generate-async/{jobId}:
    get:
      tags:
        - Detections
      summary: Get async SIEM query generation status
      description: >-
        Returns the current status of a background detection query generation
        job.
      parameters:
        - in: path
          name: jobId
          description: Detection query generation job ID
          schema:
            type: string
            format: uuid
            description: Detection query generation job ID
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - pending
                          - in_progress
                    required:
                      - status
                  - type: object
                    properties:
                      status:
                        type: string
                        const: succeeded
                      result:
                        type: object
                        properties:
                          query:
                            type: string
                            description: The generated SIEM query
                          systemPrompt:
                            type: string
                            description: >-
                              The customized system prompt for the detection
                              agent
                          explanation:
                            type: string
                            description: Optional explanation of what the query does
                        required:
                          - query
                          - systemPrompt
                    required:
                      - status
                      - result
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - failed
                          - canceled
                          - expired
                          - skipped
                      error:
                        type: string
                    required:
                      - status
                      - error
        '400':
          description: Bad request — input validation failed or the request was malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized — missing or invalid API key / session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the authenticated user lacks the required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: shell
          label: cURL
          source: >-
            curl -X GET
            "https://app.cotool.ai/api/detection-queries/generate-async/:jobId"
            \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json"
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        issues:
          type: array
          description: >-
            Detailed validation issues, present when request or response schema
            validation fails
          items:
            type: object
            additionalProperties: true
      required:
        - error
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
      required:
        - error
    PermissionError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        missingPerms:
          type: array
          description: Permissions the authenticated user is missing for this operation
          items:
            type: string
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key authentication for programmatic access. Include your API key in
        the Authorization header as: `Bearer your_api_key_here`

````