> ## Documentation Index > Fetch the complete documentation index at: https://docs.nvisy.com/llms.txt > Use this file to discover all available pages before exploring further. # List workspace runs > Returns all pipeline runs across the workspace, most recent first, with optional status, file, pipeline, trigger-account, and trigger-type filters. ## OpenAPI ````yaml /api-reference/openapi.json get /workspaces/{workspaceSlug}/pipelines/runs/ openapi: 3.1.0 info: title: Nvisy API summary: Document processing and annotation platform description: >- Nvisy provides intelligent document processing, annotation, and analysis capabilities. This API enables document upload, OCR processing, embedding generation, and semantic search across your document collections. termsOfService: https://nvisy.com/legal/terms-of-service contact: name: Nvisy Support url: https://nvisy.com email: hello@nvisy.com license: name: Proprietary url: https://nvisy.com/license version: 0.1.0 servers: [] security: [] tags: - name: Accounts description: Account management and profile operations - name: Authentication description: Login, signup, and token management - name: Workspaces description: Workspace creation and management - name: Files description: File upload, download, and management - name: Members description: Workspace member management - name: Invites description: Workspace invitation handling - name: API Tokens description: API token management - name: Connections description: External provider connections - name: Pipelines description: Redaction pipeline configuration - name: Pipeline Runs description: Pipeline run execution and review - name: Policies description: Redaction policy configuration - name: Webhooks description: Webhook configuration - name: Notifications description: Account notification management - name: Health description: Service health checks paths: /workspaces/{workspaceSlug}/pipelines/runs/: get: tags: - Pipeline Runs summary: List workspace runs description: >- Returns all pipeline runs across the workspace, most recent first, with optional status, file, pipeline, trigger-account, and trigger-type filters. parameters: - in: path name: workspaceSlug description: URL-safe workspace identifier. required: true schema: description: URL-safe workspace identifier. type: string style: simple - in: query name: after description: |- Cursor pointing to the last item of the previous page. Obtain this from the `nextCursor` field in the response. schema: description: |- Cursor pointing to the last item of the previous page. Obtain this from the `nextCursor` field in the response. type: string style: form - in: query name: limit description: 'The maximum number of records to return (1-100, default: 20).' schema: description: 'The maximum number of records to return (1-100, default: 20).' type: integer format: uint32 maximum: 100 minimum: 1 style: form - in: query name: fileId description: Filter by the source file the run analyzes. schema: description: Filter by the source file the run analyzes. type: string format: uuid style: form - in: query name: pipelineId description: Filter by the owning pipeline. schema: description: Filter by the owning pipeline. type: string format: uuid style: form - in: query name: status description: Filter by run status. schema: $ref: '#/components/schemas/PipelineRunStatus' description: Filter by run status. style: form - in: query name: triggerType description: Filter by how the run was initiated (user vs system). schema: $ref: '#/components/schemas/PipelineTriggerType' description: Filter by how the run was initiated (user vs system). style: form - in: query name: triggeredBy description: Filter by the account that triggered the run. schema: description: Filter by the account that triggered the run. type: string format: uuid style: form responses: '200': description: >- Generic paginated response wrapper. Provides a consistent structure for all paginated API responses with cursor-based pagination support. When `next_cursor` is present, there are more items to fetch. content: application/json: schema: $ref: '#/components/schemas/PipelineRunPage' '401': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: PipelineRunStatus: description: >- Defines the execution status of a pipeline run. This enumeration corresponds to the `PIPELINE_RUN_STATUS` PostgreSQL enum and is used to track the current state of a pipeline execution. The detect phase has two states: `Queued` (the run is enqueued but no worker has begun) and `Analyzing` (a worker is actively analyzing). They settle into `Analyzed` (detection done, awaiting review), then `Completed` after redaction. oneOf: - description: Enqueued for detection; no worker has picked it up yet type: string const: queued - description: A worker is actively analyzing the document type: string const: analyzing - description: Detection done; awaiting reviewer verification type: string const: analyzed - description: Redaction applied; run finished type: string const: completed - description: Run failed with error type: string const: failed - description: Run was cancelled by user type: string const: cancelled PipelineTriggerType: description: >- Defines how a pipeline run was initiated. This enumeration corresponds to the `PIPELINE_TRIGGER_TYPE` PostgreSQL enum: a run is either started directly by a user or automatically by the system (for example, a file upload that the pipeline auto-redacts). oneOf: - description: Started directly by a user. type: string const: user - description: >- Started automatically by the system (e.g. a file upload auto-redacted by the pipeline). type: string const: system PipelineRunPage: description: |- Generic paginated response wrapper. Provides a consistent structure for all paginated API responses with cursor-based pagination support. When `next_cursor` is present, there are more items to fetch. type: object properties: items: description: Items in this page. type: array items: $ref: '#/components/schemas/PipelineRun' nextCursor: description: Cursor to fetch the next page. Present only when more items exist. type: string total: description: Total count of items matching the query (if requested). type: integer format: int64 required: - items ErrorResponse: description: |- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. type: object properties: message: description: User-friendly error message safe for client display type: string name: description: The error name/type identifier type: string resource: description: The resource that the error relates to (optional, set by handler) type: string suggestion: description: Helpful suggestion for resolving the error (optional) type: string validation: description: Validation error details for field-specific errors type: array items: $ref: '#/components/schemas/ValidationErrorDetail' required: - name - message PipelineRun: description: >- Response type for a pipeline run. A run is addressed by its own opaque id; the owning pipeline and workspace slugs are carried for context. type: object properties: completedAt: description: When the run completed. type: string format: date-time error: description: Human-readable failure reason, present only when the run `failed`. type: string id: description: Opaque identifier of the run. allOf: - $ref: '#/components/schemas/RunId' inputFileId: description: Source document this run analyzes / redacts. type: string format: uuid inputFileName: description: >- Display name of the source document, for showing the run without a separate file lookup. `None` if the file was removed (e.g. by retention). type: string metadata: description: Non-encrypted metadata for filtering/display. allOf: - $ref: '#/components/schemas/RunMetadata' outputFileId: description: Redacted document produced by the run, once it completes. type: string format: uuid outputFileName: description: Display name of the redacted output, once the run completes. type: string pipelineSlug: description: Handle of the pipeline this run belongs to. allOf: - $ref: '#/components/schemas/Handle' startedAt: description: When the run started. type: string format: date-time status: description: |- Current run status. The detections are available to fetch from the run's `detections` endpoint once this reaches `analyzed`. allOf: - $ref: '#/components/schemas/PipelineRunStatus' triggerType: description: How the run was triggered. allOf: - $ref: '#/components/schemas/PipelineTriggerType' triggeredBy: description: Account that triggered the run. allOf: - $ref: '#/components/schemas/AccountRef' workspaceSlug: description: Handle of the workspace this run belongs to. allOf: - $ref: '#/components/schemas/Handle' required: - id - pipelineSlug - workspaceSlug - inputFileId - triggeredBy - triggerType - status - metadata - startedAt ValidationErrorDetail: description: Validation error details for field-specific errors. type: object properties: code: description: Error code for the validation failure type: string field: description: Field name that failed validation type: string message: description: Human-readable error message type: string params: description: Additional parameters related to the validation error type: object additionalProperties: true required: - field - code - message RunId: description: Opaque run identifier (run_). type: string pattern: >- ^run_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ RunMetadata: description: Structured metadata for a pipeline run. type: object properties: error: description: Failure reason recorded when the run failed. type: string tags: description: Free-form labels attached to the run. type: array items: type: string Handle: description: >- Lowercase, dash-separated identifier used in URLs and as account handles. type: string maxLength: 32 minLength: 3 pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$ AccountRef: description: >- Public reference to the account behind a resource — whoever created it, uploaded it, triggered it, or performed it. Reused across resource responses so an account is always presented the same way: a handle plus an optional avatar. type: object properties: avatarUrl: description: Serve path of the account's avatar, when set. type: string displayName: description: Human-readable display name, when set. type: string username: description: Handle of the account. allOf: - $ref: '#/components/schemas/Handle' required: - username ````