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

# Consultar status de job de dossiê em lote

> Retorna o status agregado do job e o status individual de cada análise nele.



## OpenAPI

````yaml GET /analyses/bulk-dossier-jobs/{job_id}
openapi: 3.1.0
info:
  description: Superfície pública da API para clientes autenticados por chave de API.
  title: NL Labs Gateway (Public API)
  version: 0.1.0
servers:
  - url: https://api.nlbs.ai
security: []
tags:
  - description: Busca de entidades canônicas.
    name: entities
  - description: Criação, leitura, grafo e dossiê de análises.
    name: analyses
  - description: Relatório regulatório (COAF/SUSEP).
    name: reports
  - description: Triagem de mídia adversa.
    name: adverse-media
  - description: Versões do manifesto regulatório.
    name: regulatory
  - description: Versões do catálogo de regras do motor de risco.
    name: rules
  - description: Endpoints e eventos de webhook.
    name: webhooks
  - description: >-
      Entrypoints HTTP de workflow: invocar um workflow e consultar sua
      execução.
    name: workflow-endpoints
paths:
  /analyses/bulk-dossier-jobs/{job_id}:
    get:
      tags:
        - analyses
      summary: Consultar status de job de dossiê em lote
      description: >-
        Retorna o status agregado do job e o status individual de cada análise
        nele.
      operationId: get_bulk_dossier_job
      parameters:
        - description: UUID do job de dossiê em lote.
          in: path
          name: job_id
          required: true
          schema:
            description: UUID do job de dossiê em lote.
            format: uuid
            title: Job Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkDossierJobStatusResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Chave de API ausente, malformada, expirada ou inválida.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: A chave de API autenticada não tem o escopo necessário.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Job não encontrado.
        '422':
          description: >-
            Corpo da requisição, parâmetro de rota, parâmetro de query ou regra
            de negócio inválidos.
components:
  schemas:
    BulkDossierJobStatusResponse:
      properties:
        completed_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Completed At
        completed_items:
          title: Completed Items
          type: integer
        created_at:
          format: date-time
          title: Created At
          type: string
        failed_items:
          title: Failed Items
          type: integer
        items:
          items:
            $ref: '#/components/schemas/BulkDossierJobItemResponse'
          title: Items
          type: array
        job_id:
          format: uuid
          title: Job Id
          type: string
        status:
          $ref: '#/components/schemas/BulkDossierJobStatus'
        total_items:
          title: Total Items
          type: integer
      required:
        - job_id
        - status
        - total_items
        - completed_items
        - failed_items
        - created_at
        - completed_at
        - items
      title: BulkDossierJobStatusResponse
      type: object
    ErrorResponse:
      properties:
        detail:
          description: Mensagem de erro pública e estável.
          examples:
            - Resource not found.
          title: Detail
          type: string
      required:
        - detail
      title: ErrorResponse
      type: object
    BulkDossierJobItemResponse:
      properties:
        analysis_uuid:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Analysis Uuid
        document:
          anyOf:
            - type: string
            - type: 'null'
          title: Document
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Message
        position:
          title: Position
          type: integer
        status:
          $ref: '#/components/schemas/BulkDossierJobItemStatus'
      required:
        - position
        - analysis_uuid
        - document
        - status
        - error_message
      title: BulkDossierJobItemResponse
      type: object
    BulkDossierJobStatus:
      enum:
        - running
        - completed
        - completed_with_errors
        - failed
      title: BulkDossierJobStatus
      type: string
    BulkDossierJobItemStatus:
      enum:
        - pending
        - completed
        - failed
      title: BulkDossierJobItemStatus
      type: string

````