Zipline Ai workflow API

The workflow API from Zipline Ai — 1 operation(s) for workflow.

OpenAPI Specification

zipline-ai-workflow-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Zipline AI Fetcher fetch workflow API
  version: v1
  description: HTTP surface of the Chronon fetcher service that powers Zipline AI online feature serving and schema inspection. These endpoints read from the online KV store and metadata uploaded during deploy, and are intended for online GroupBys and Joins. This document was generated by the API Evangelist enrichment pipeline from the provider's published documentation (https://zipline.ai/docs/setup/Fetcher_API); the provider does not publish an OpenAPI definition. Fetcher runs self-hosted within the customer's cloud, so the server host is deployment-specific.
  x-generated-by: api-evangelist-enrichment
  x-generated-method: generated
  x-source: https://zipline.ai/docs/setup/Fetcher_API
servers:
- url: http://localhost:9000
  description: Local sandbox default (docker-compose)
- url: https://{host}
  description: Self-hosted deployment host
  variables:
    host:
      default: zipline.example.com
tags:
- name: workflow
paths:
  /workflow/v2/{workflowId}/status:
    get:
      tags:
      - workflow
      operationId: getWorkflowStatus
      summary: Poll workflow state after a run has been created
      description: Returns the workflow-level status and the node execution timeline for a workflow run. Requires viewer access when role-based authorization is enabled. When authentication is enabled, include a bearer token (obtainable via `zipline auth get-access-token`).
      parameters:
      - name: workflowId
        in: path
        required: true
        description: Workflow ID returned by the workflow start API or shown in the Zipline Hub UI.
        schema:
          type: string
      responses:
        '200':
          description: Workflow status and node execution timeline
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStatus'
        '401':
          description: Missing or invalid bearer token
        '403':
          description: Caller lacks viewer access
        '503':
          description: Authentication service unavailable (JWKS endpoint unreachable)
components:
  schemas:
    WorkflowStatus:
      type: object
      properties:
        workflowId:
          type: string
        confName:
          type: string
        mode:
          type: string
        branch:
          type: string
        user:
          type: string
        status:
          type: string
        startPartition:
          type: string
        endPartition:
          type: string
        terminalNodes:
          type: array
          items:
            type: string
        nodeExecutions:
          type: array
          items:
            $ref: '#/components/schemas/NodeExecution'
    StepRun:
      type: object
      properties:
        runId:
          type: string
        workflowId:
          type: string
        startPartition:
          type: string
        endPartition:
          type: string
        status:
          type: string
        attempt:
          type: string
        jobTrackingInfo:
          type: object
          properties:
            jobUrl:
              type: string
    NodeExecution:
      type: object
      properties:
        nodeName:
          type: string
        nodeHash:
          type: string
        startPartition:
          type: string
        endPartition:
          type: string
        dependencies:
          type: array
          items:
            type: string
        stepRuns:
          type: array
          items:
            $ref: '#/components/schemas/StepRun'