AnomalyArmor Jobs API

openapi: 3.2.0
info:
  title: Anomalyarmor Ai Jobs API
  version: 1.0.0
  contact:
    name: AnomalyArmor Support
    url: https://anomalyarmor.ai/support
  license:
    name: Proprietary
  description: 'Operations tagged jobs across 3 of this provider''s published API definitions: anomalyarmor.ai-openapi.json, app.anomalyarmor.ai-openapi.json, docs.anomalyarmor.ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8000
  description: Development server
- url: https://api.anomalyarmor.ai
  description: Production server
tags:
- name: Jobs
paths:
  /api/v1/jobs/workflows:
    post:
      tags:
      - Jobs
      summary: Submit Workflow
      description: 'Submit a new workflow for execution.


        Args:

        request: Workflow submission request

        ctx: Application context with user and session

        workflow_service: Workflow service dependency


        Returns:

        StandardResponse: Job ID and status


        Raises:

        ValidationError: If workflow submission fails validation'
      operationId: submit_workflow_api_v1_jobs_workflows_post
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowSubmissionRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/jobs/{job_id}:
    get:
      tags:
      - Jobs
      summary: Get Job Status
      description: 'Get status of a specific job.


        Args:

        job_id: Job identifier (UUID)

        ctx: Application context with user and session

        job_adapter: Job adapter dependency

        asset_provider: Asset provider dependency


        Returns:

        StandardResponse: Job status details


        Raises:

        NotFoundError: If job not found or access denied'
      operationId: get_job_status_api_v1_jobs__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Job Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDetailEnvelope'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Jobs
      summary: Cancel Job
      description: 'Cancel a job.


        Args:

        job_id: Job identifier (UUID)

        ctx: Application context with user and session

        job_adapter: Job adapter dependency


        Returns:

        StandardResponse: Cancellation result


        Raises:

        NotFoundError: If job not found or cannot be cancelled'
      operationId: cancel_job_api_v1_jobs__job_id__delete
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Job Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/jobs/:
    get:
      tags:
      - Jobs
      summary: List Jobs
      description: 'List jobs for the current user''s company with efficient pagination.


        This endpoint has been optimized for performance as part of TECH-100.

        It now uses efficient count queries instead of loading all jobs into memory.


        Args:

        ctx: Application context with user and session

        job_adapter: Job adapter dependency

        asset_provider: Asset provider dependency

        pagination: Pagination parameters (limit, offset)

        status: Optional status filter

        workflow_name: Optional workflow name filter

        sort_by: Field to sort by

        sort_order: Sort order (ASC or DESC)


        Returns:

        StandardResponse: List of jobs with pagination metadata'
      operationId: list_jobs_api_v1_jobs__get
      parameters:
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by job status
          title: Status
        description: Filter by job status
      - name: workflow_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by workflow name
          title: Workflow Name
        description: Filter by workflow name
      - name: asset_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Filter by asset UUID
          title: Asset Id
        description: Filter by asset UUID
      - name: sort_by
        in: query
        required: false
        schema:
          type: string
          pattern: ^(created_at|status|workflow_name|priority)$
          default: created_at
          title: Sort By
      - name: sort_order
        in: query
        required: false
        schema:
          type: string
          pattern: ^(ASC|DESC)$
          default: DESC
          title: Sort Order
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Items per page
          default: 20
          title: Limit
        description: Items per page
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Items to skip
          default: 0
          title: Offset
        description: Items to skip
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListEnvelope'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/jobs/system/status:
    get:
      tags:
      - Jobs
      summary: Get System Status
      description: 'Get job system status.


        Args:

        ctx: Application context with user and session

        workflow_service: Workflow service dependency

        job_adapter: Job adapter dependency


        Returns:

        StandardResponse: System status information'
      operationId: get_system_status_api_v1_jobs_system_status_get
      parameters:
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/jobs/{job_id}/steps:
    get:
      tags:
      - Jobs
      summary: Get Job Steps
      description: 'Get all steps/phases for a specific job.


        Args:

        job_id: Job identifier (UUID)

        ctx: Application context with user and session


        Returns:

        StandardResponse: List of job steps with timing and progress information


        Raises:

        NotFoundError: If job not found

        ForbiddenError: If access denied'
      operationId: get_job_steps_api_v1_jobs__job_id__steps_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Job Id
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
  /api/v1/jobs/recent/activity:
    get:
      tags:
      - Jobs
      summary: Get Recent Activity
      description: 'Get recent job activity for the homepage activity feed.


        Returns the most recent completed or failed jobs for the current company,

        with asset names and human-readable summaries.


        Args:

        ctx: Application context with user and session

        job_adapter: Job adapter dependency

        asset_provider: Asset provider dependency

        limit: Maximum number of activities (1-50, default 10)


        Returns:

        StandardResponse: List of recent activity items'
      operationId: get_recent_activity_api_v1_jobs_recent_activity_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          description: Maximum number of activities to return
          default: 10
          title: Limit
        description: Maximum number of activities to return
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: http://localhost:8000
      description: Development server
    - url: https://api.anomalyarmor.ai
      description: Production server
components:
  schemas:
    JobPriority:
      type: string
      enum:
      - low
      - normal
      - high
      - urgent
      title: JobPriority
      description: Job priority levels for queue ordering.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    JobListEnvelope:
      properties:
        success:
          type: boolean
          title: Success
        data:
          anyOf:
          - $ref: '#/components/schemas/JobListPageData'
          - type: 'null'
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      required:
      - success
      title: JobListEnvelope
      description: Typed ``StandardResponse`` envelope for the job list endpoint.
    JobListPageData:
      properties:
        jobs:
          items:
            $ref: '#/components/schemas/JobStatusResponse'
          type: array
          title: Jobs
          description: Page of jobs
        pagination:
          $ref: '#/components/schemas/OffsetPaginationMeta'
          description: Pagination metadata
      type: object
      required:
      - pagination
      title: JobListPageData
      description: 'Data payload for the paginated job list endpoint.


        Mirrors the exact shape returned by ``list_jobs``: the page of jobs plus

        offset-based pagination metadata. Declaring it as a ``response_model``

        lands ``JobStatusResponse`` in the OpenAPI spec so the frontend can alias

        the generated schema (TECH-1003 / TECH-998).'
    JobDetailResponse:
      properties:
        job_id:
          type: string
          title: Job Id
          description: Unique job identifier
        workflow_name:
          type: string
          title: Workflow Name
          description: Name of the workflow
        status:
          type: string
          title: Status
          description: Raw job status (not normalized)
        job_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Job Type
          description: Workflow name alias
        priority:
          type: string
          title: Priority
          description: Job priority level
          default: normal
        worker_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Worker Id
          description: Worker that ran the job
        progress_percent:
          type: integer
          title: Progress Percent
          description: Job progress percentage
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Job creation timestamp
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started At
          description: Job start timestamp
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
          description: Job completion timestamp
        estimated_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Estimated Duration
          description: Estimated duration in seconds
        context:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Context
          description: Sanitized job context
        filters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Filters
          description: Job filters
        result_data:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Result Data
          description: Raw job result payload
        result:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Result
          description: Parsed job result payload
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
          description: Error message if the job failed
        created_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Created By
          description: Process/user identifier that created the job
        asset_uuid:
          anyOf:
          - type: string
          - type: 'null'
          title: Asset Uuid
          description: Public UUID of the asset this job processed
      additionalProperties: true
      type: object
      required:
      - job_id
      - workflow_name
      - status
      - created_at
      title: JobDetailResponse
      description: 'Response model for the single-job detail endpoint (``get_job_status``).


        Mirrors the payload ``get_job_status`` returns (the DAL row minus internal

        IDs, plus ``asset_uuid`` and the ``job_type`` alias the DAL adds). Unlike

        ``JobStatusResponse``, ``status`` is NOT normalized here (the detail endpoint

        returns the raw DB status), and ``result_data`` is included (the frontend

        reads it for completion / skip detection). Declaring it as a

        ``response_model`` lands the schema in the spec so the frontend can alias it

        (TECH-1003 / TECH-998 ``core-dsq``).


        ``extra="allow"`` is deliberate: the DAL builds this dict, so any field it

        adds in the future passes through unchanged instead of being silently

        dropped by response-model serialization. Only the fields below are typed for

        the frontend; anything else is preserved verbatim.'
    StandardResponse:
      properties:
        success:
          type: boolean
          title: Success
        data:
          anyOf:
          - {}
          - type: 'null'
          title: Data
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      required:
      - success
      title: StandardResponse
      description: Standard API response wrapper.
    JobStatusResponse:
      properties:
        job_id:
          type: string
          title: Job Id
          description: Unique job identifier
        workflow_name:
          type: string
          title: Workflow Name
          description: Name of the workflow
        status:
          type: string
          title: Status
          description: Current job status (normalized for display)
        priority:
          type: string
          title: Priority
          description: Job priority level
          default: normal
        job_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Job Type
          description: Type of job (refresh, intelligence, asset_discovery)
        progress_percent:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Progress Percent
          description: Job progress percentage
          default: 0
        progress_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Progress Message
          description: Current progress message
        current_phase:
          anyOf:
          - type: integer
          - type: 'null'
          title: Current Phase
          description: Current workflow phase
        total_phases:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Phases
          description: Total workflow phases
        created_at:
          type: string
          title: Created At
          description: Job creation timestamp (timezone-aware)
        started_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Started At
          description: Job start timestamp (timezone-aware)
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
          description: Job completion timestamp
        estimated_duration:
          type: integer
          title: Estimated Duration
          description: Estimated duration in seconds
          default: 0
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
          description: Error message if job failed
        asset_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Asset Name
          description: Name of the asset this job is processing
        asset_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Asset Type
          description: Type of the asset this job is processing
        asset_uuid:
          anyOf:
          - type: string
          - type: 'null'
          title: Asset Uuid
          description: UUID of the asset this job is processing
        context:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Context
          description: Job context containing configuration parameters
        filters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Filters
          description: Job filters and options
        result:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Result
          description: Job result data
      type: object
      required:
      - job_id
      - workflow_name
      - status
      - created_at
      title: JobStatusResponse
      description: 'Response model for job status information.


        Note: The ''status'' field is normalized for user display. Internal statuses

        like ''claimed'' are mapped to user-friendly equivalents (e.g., ''running'').'
    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
    OffsetPaginationMeta:
      properties:
        offset:
          type: integer
          title: Offset
        limit:
          type: integer
          title: Limit
        total:
          type: integer
          title: Total
        has_next:
          type: boolean
          title: Has Next
        has_prev:
          type: boolean
          title: Has Prev
      type: object
      required:
      - offset
      - limit
      - total
      - has_next
      - has_prev
      title: OffsetPaginationMeta
      description: Offset-based pagination metadata.
    WorkflowSubmissionRequest:
      properties:
        workflow_name:
          type: string
          title: Workflow Name
          description: Name of the workflow to execute
        context:
          additionalProperties: true
          type: object
          title: Context
          description: Workflow execution context
        filters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Filters
          description: Optional filters for workflow
        priority:
          $ref: '#/components/schemas/JobPriority'
          description: Job priority level
          default: normal
        estimated_duration:
          anyOf:
          - type: integer
          - type: 'null'
          title: Estimated Duration
          description: Estimated duration in seconds
      type: object
      required:
      - workflow_name
      title: WorkflowSubmissionRequest
      description: Request model for submitting a new workflow.
    JobDetailEnvelope:
      properties:
        success:
          type: boolean
          title: Success
        data:
          anyOf:
          - $ref: '#/components/schemas/JobDetailResponse'
          - type: 'null'
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        meta:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Meta
      type: object
      required:
      - success
      title: JobDetailEnvelope
      description: Typed ``StandardResponse`` envelope for the job detail endpoint.
x-refined-from:
- anomalyarmor.ai-openapi.json
- app.anomalyarmor.ai-openapi.json
- docs.anomalyarmor.ai-openapi.json