Skip to main content

​
Overview

Artifacts are the data outputs generated by workflow runs. When workflows execute, they produce various types of artifacts such as extracted data (JSON, CSV), screenshots, documents (PDF), logs, and other files that represent the results of the data operation. Artifacts are the primary means of retrieving the actual data collected during workflow execution. They provide structured access to the information extracted from source systems, along with supporting files like screenshots and logs that help audit and debug the extraction process.

​
Key Concepts

​
Artifact Properties

Each artifact includes:
  • Type: The category or nature of the artifact (e.g., extracted_data, screenshot, log_file)
  • Display Name: A human-readable name for the artifact
  • MIME Type: The file type (e.g., application/json, image/png, application/pdf, text/csv)
  • File Size: Size of the artifact in bytes
  • File Hash: A hash of the file content for integrity verification
  • Storage Path: Internal reference to where the artifact is stored
  • Signed URL: A temporary, secure URL for downloading the artifact content

​
Artifact Association

Artifacts are linked to:
  • Workflow ID: The workflow that generated the artifact
  • Workflow Run ID: The specific workflow run execution that created it
This dual association allows you to:
  • Find all artifacts ever generated by a workflow
  • Retrieve artifacts from a specific workflow execution

​
Signed URLs

The signedUrl field provides secure, time-limited access to artifact content:
  • Valid for a limited time (typically 15 minutes)
  • Requires no additional authentication once generated
  • Can be shared or used directly in applications
  • Expires automatically for security
Signed URLs expire after 15 minutes. If you need continued access to an artifact, fetch a new URL by retrieving the artifact again via the API.

​
Artifact Types

Common artifact types include: Extracted Data
  • JSON files containing structured data extracted from source systems
  • CSV files with tabular data
  • XML or other structured formats
Visual Records
  • Screenshots of key pages or steps during workflow execution
  • PDF documents retrieved from source systems
  • Images captured during the process
Source Documents
  • Employee records downloaded from HR systems
  • Financial reports from accounting systems
  • Tax forms and compliance documents

​
API Operations

​
List Artifacts

List Artifacts

Retrieve artifacts for your organization with pagination support

​
Get an Artifact

Get Artifact

Retrieve detailed information about a specific artifact, including a fresh signed URL
Once you have the signed URL, you can download the artifact content directly. The URL expires after 15 minutes, so fetch a new one if needed.

​
Relationship with Other Resources

  • Workflows: The template that defines artifact generation
  • Workflow Runs: The execution instance that created the artifact
  • Job Runs: The overall execution that triggered the workflow run

​
Best Practices

​
Artifact Retrieval

  1. Fetch When Needed: Request artifacts only when you need to access their content
  2. Handle Expiration: Implement logic to refresh signed URLs when they expire, if displayed in your application
  3. Filter Efficiently: Use specific queries to retrieve only needed artifacts

​
Security

  1. Protect URLs: Don’t expose signed URLs publicly or log them
  2. Time Awareness: Remember that signed URLs expire after 15 minutes
  3. Verify Sources: Confirm artifacts come from expected workflow runs
  4. Access Control: Implement proper access controls for artifact data

​
Schema Reference

See the API Reference for complete schema definitions and field descriptions for the Artifact resource.