Skip to main content

​
Anon API

The Anon V2 API provides comprehensive access to workflows, jobs, and artifacts generated by your custom data operations. This guide introduces the core concepts you need to understand to effectively build and manage workflows with Anon.
This guide covers the fundamental concepts of the Anon V2 API. For step-by-step implementation instructions, see the Quickstart guide.

​
Resource-Based API

Anon offers a REST API that follows resource-based principles. Each entity in the system (workflows, jobs, workflow runs, artifacts) is a resource with a unique identifier that can be created, retrieved, updated, and managed through standard HTTP methods.

​
Core Resources

​
Workflows

Workflows are the fundamental building blocks in Anon V2. Each workflow represents a customizable sequence of steps that the AI agent executes to accomplish a specific task. Key Features:
  • User-Defined: You define the steps, logic, and flow of each workflow
  • Reusable: Create workflows once and execute them multiple times
  • Modifiable: Update workflows to adapt to changing requirements
  • Provider-Specific: Workflows are designed for specific source providers (e.g., Gusto, Rippling, QuickBooks)
Workflow Types:
  • Login workflows: Special workflows for authenticating with source systems
  • User-defined workflows: Custom browser automation workflows you create for data operations
The API allows you to:
  • Create new workflows with custom step definitions
  • List and retrieve existing workflows
  • Update workflow definitions
  • Delete workflows you no longer need
Workflows contain a stepsJson field that defines the sequence of actions the AI agent should perform. This JSON structure includes steps, input schemas, and metadata.

​
Workflow Runs

Each execution of a workflow creates a workflow run. Workflow runs track the progress and status of individual workflow executions. The API allows you to:
  • Execute a workflow by creating a new workflow run
  • Track the status and progress of workflow runs
  • Access artifacts generated during workflow execution

​
Jobs

Jobs are collections of workflows organized with a specific execution order. Use jobs to orchestrate complex, multi-step data operations that require coordinating multiple workflows. Example Use Case: A data migration job might include:
  1. Login workflow (authenticate with source system)
  2. Employee data extraction workflow
  3. Payroll data extraction workflow
  4. Tax document retrieval workflow
The API allows you to:
  • Create jobs with multiple workflows
  • Define workflow execution order
  • Update job configurations
  • Delete jobs

​
Job Runs

When you execute a job, it creates a job run. Job runs manage the execution of all workflows in the job according to the defined order. Job Run Features:
  • Executes workflows in sequence according to the defined workflowExecutionOrder, which is a property of the job
  • Tracks overall job run status and individual workflow run statuses
  • Maintains a snapshot of the job configuration at execution time
  • Provides browser debugging capabilities for testing and iteration
The API allows you to:
  • List job runs to see execution history
  • Retrieve individual job run details
  • Monitor the status of workflow executions within a job
Job runs create separate workflow runs for each workflow in the job. Check both job run status and individual workflow run statuses for detailed progress tracking.

​
Artifacts

Artifacts are the data outputs generated by workflow runs. When workflows execute, they can produce various types of artifacts such as extracted data, screenshots, documents, and structured files. Artifact Properties:
  • type: The category or nature of the artifact
  • displayName: Human-readable name for the artifact
  • mimeType: File type (e.g., application/json, image/png, application/pdf)
  • fileSize: Size in bytes
  • signedUrl: Temporary, secure URL for downloading the artifact
  • storagePath: Internal storage location reference
Artifact Organization: Artifacts are linked to:
  • The workflow that generated them (workflowId)
  • The specific workflow run that created them (workflowRunId)
The API allows you to:
  • List artifacts for a specific workflow run
  • Retrieve individual artifact details
  • Download artifact content via signed URLs
Signed URLs for artifacts are temporary and expire in 15 minutes after generation. Generate new URLs if needed for continued access.

​
Getting Started

To begin building with Anon V2:
  1. Create Workflows: Define the steps for each data operation you need
  2. Test Workflows: Execute workflow runs to verify behavior
  3. Build Jobs: Combine workflows into jobs for complex operations
  4. Monitor Execution: Track job and workflow run statuses
  5. Access Artifacts: Retrieve the data generated by your workflows