Zipline Ai fetch API

openapi: 3.0.3
info:
  title: Zipline AI Fetcher fetch 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: fetch
paths:
  /v1/fetch/groupby/{name}:
    post:
      tags:
      - fetch
      operationId: fetchGroupBy
      summary: Fetches features for one GroupBy
      parameters:
      - $ref: '#/components/parameters/Name'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchRequest'
      responses:
        '200':
          description: Feature fetch results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchResponse'
        '400':
          description: Request-level failure (e.g. invalid JSON) — returns an errors array
  /v1/fetch/join/{name}:
    post:
      tags:
      - fetch
      operationId: fetchJoin
      summary: Fetches features for one join
      parameters:
      - $ref: '#/components/parameters/Name'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchRequest'
      responses:
        '200':
          description: Feature fetch results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchResponse'
        '400':
          description: Request-level failure (e.g. invalid JSON) — returns an errors array
  /v1/fetch/modeltransforms/{name}:
    post:
      tags:
      - fetch
      operationId: fetchModelTransforms
      summary: Fetches model transform outputs
      parameters:
      - $ref: '#/components/parameters/Name'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchRequest'
      responses:
        '200':
          description: Model transform outputs
  /v2/fetch/join/{name}:
    post:
      tags:
      - fetch
      operationId: fetchJoinV2
      summary: Fetches join features with the feature payload encoded as a base64 Avro string
      parameters:
      - $ref: '#/components/parameters/Name'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchRequest'
      responses:
        '200':
          description: Join features with base64 Avro-encoded payload
components:
  parameters:
    Name:
      name: name
      in: path
      required: true
      description: Chronon metadata name. URL-encode names that contain path separators.
      schema:
        type: string
  schemas:
    FetchResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/FetchResult'
        errors:
          type: array
          description: Present on request-level failures such as invalid JSON
          items:
            type: string
    FetchRequest:
      type: array
      description: A JSON array of entity key maps; each map is one lookup. Response preserves request order.
      items:
        type: object
        additionalProperties: true
        example:
          user_id: '5'
    FetchResult:
      type: object
      properties:
        status:
          type: string
          enum:
          - Success
          - Failure
        entityKeys:
          type: object
          additionalProperties: true
        features:
          type: object
          additionalProperties: true
        error:
          type: string
          description: Present when status is Failure