> ## Documentation Index > Fetch the complete documentation index at: https://docs.slate.inc/llms.txt > Use this file to discover all available pages before exploring further. # Get redaction job status > Return a lightweight status snapshot for polling. Includes just the fields needed to advance a job from pending or processing to a terminal state. ## OpenAPI ````yaml /api-reference/files/openapi.yaml get /v1/redactions/{redactionId}/status openapi: 3.0.0 info: title: Files & Requests API version: 1.2.0 description: > Manage evidence and claims requests, attach exhibits, fill state-specific templates, generate PDF files, run PDF redaction jobs, and store and retrieve a matter's files and media. contact: name: Slate API Support email: api-support@slate.inc url: https://slate.inc servers: - url: https://api.slate.inc/files description: Production - url: https://api.uat.slate.inc/files description: UAT (staging) security: - bearerAuth: [] tags: - name: Requests description: Create, read, update, and generate evidence and claims requests - name: Exhibits description: Upload, download, and delete exhibits - name: Files description: Files and media associated with a matter - name: Redactions description: Asynchronous PDF redaction jobs - name: Bulk Downloads description: Asynchronous bulk download jobs paths: /v1/redactions/{redactionId}/status: parameters: - $ref: '#/components/parameters/redactionId' get: tags: - Redactions summary: Get redaction job status description: > Return a lightweight status snapshot for polling. Includes just the fields needed to advance a job from pending or processing to a terminal state. operationId: getRedactionStatus responses: '200': description: Redaction job status snapshot content: application/json: schema: $ref: '#/components/schemas/RedactionStatusSnapshot' '401': description: Unauthorized or invalid permissions content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Redaction not found or you do not have permission to access it content: application/json: schema: $ref: '#/components/schemas/Error' components: parameters: redactionId: in: path name: redactionId required: true schema: type: string format: uuid schemas: RedactionStatusSnapshot: type: object required: - id - status description: > Lightweight status snapshot returned by `GET /v1/redactions/{redactionId}/status` for polling. properties: id: type: string format: uuid status: $ref: '#/components/schemas/RedactionStatus' completedOn: type: string format: date-time nullable: true redactionDuration: type: string nullable: true errorMessage: type: string nullable: true description: Populated when processing fails; null otherwise. summary: $ref: '#/components/schemas/RedactionRunSummary' nullable: true description: >- Per-rule redaction counts and OCR signals. Null until the job completes. Error: type: object required: - message - reason properties: message: type: string description: A human readable error message reason: $ref: '#/components/schemas/ErrorReason' RedactionStatus: type: string description: Current status of an asynchronous redaction job enum: - pending - processing - completed - failed RedactionRunSummary: type: object description: Per-rule redaction counts and run signals. properties: ocrUsed: type: boolean description: Whether OCR ran over at least one page. rules: type: array description: Per-rule counts, positionally aligned to the job's rules. items: $ref: '#/components/schemas/RedactionRuleSummary' ErrorReason: type: string enum: - MISSING_TOKEN_OR_PERMISSIONS - NO_MATCHING_TRIGGER - OWNER_REQUIRED - FILE_REQUEST_NOT_PENDING - DUPLICATE_FILE_REQUEST - TEMPLATE_TYPE_REQUIRED - TEMPLATE_INDEX_REQUIRED - INVALID_MATTER_ID - MATTER_ID_REQUIRED - MATTER_NOT_FOUND - FILES_LIST_EMPTY - TOO_MANY_FILES - FILE_NAME_REQUIRED - FILE_NAME_MUST_BE_PDF - INVALID_FILE_TYPE - INVALID_TEMPLATE_IDENTIFIER - GENERATION_FAILED - EXHIBIT_ORDER_REQUIRED - CRID_REQUIRED - INVALID_FILE_NAME - ARTIFACT_TAG_NOT_FOUND - INVALID_LIMIT - INVALID_CURSOR - INVALID_ORDER_BY - MISSING_FILTER_DEPENDENCY - INVALID_FILTER - REQUEST_BODY_REQUIRED - INVALID_LABEL_RANGE - INVALID_REDACTION_RULE - REDACTION_NOT_FOUND - REDACTION_NOT_READY - FILE_UPLOAD_PENDING - BULK_DOWNLOAD_NOT_FOUND - BULK_DOWNLOAD_NOT_READY RedactionRuleSummary: type: object properties: textCount: type: integer description: Occurrences redacted on the text layer. ocrCount: type: integer description: Occurrences redacted via OCR. redactions: type: array description: > Geometry of the OCR-located redactions for this rule (one entry per recognized word). Empty for a text-only rule: text-layer matches are count-only. `ocrCount` counts occurrences while this lists boxes, so a multi-word match adds one to `ocrCount` but several entries here. items: $ref: '#/components/schemas/RedactionBox' RedactionBox: type: object description: > One OCR-located redaction's geometry. Coordinates are in PDF user space (points, bottom-left origin) — the space the box is drawn in. properties: page: type: integer description: 1-based page number. x: type: number format: float description: Lower-left x, in points. 'y': type: number format: float description: Lower-left y, in points (bottom-left origin). w: type: number format: float description: Width, in points. h: type: number format: float description: Height, in points. confidence: type: number format: double description: OCR engine confidence for the recognized word, 0–100. source: type: string enum: - ocr description: How the redaction was located. Always `ocr` in v1. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Cognito-issued JWT access token. Send it as `Authorization: Bearer `. ````