Figure Eight

Figure Eight Workflow Filter Rules API

Rules for routing data

GitHub OpenAPI

Operations 4

POST /step_routes/{route_id}/filter_rules Create a FilterRule for the step #
GET /step_routes/{route_id}/filter_rules View the list of filter rules associated with a Route #
PATCH /step_routes/{route_id}/filter_rules/{rule_id} Update a Rule associated with a Route #
DELETE /step_routes/{route_id}/filter_rules/{rule_id} Delete a rule associated with a Route #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/figure-eight/openapi/figure-eight-workflow-filter-rules-api-openapi.yml

Other Resources

🔗
Webhooks
https://artifacts.apis.io/figure-eight/asyncapi/figure-eight-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/figure-eight:figure-eight-workflow-filter-rules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

figure-eight-workflow-filter-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Appen Platform Workflow Filter Rules API
  version: 1.0.0
  description: '# Introduction

    Hello, and welcome to Appen, the leading data annotation platform for Machine Learning.'
  license:
    name: Licensed under Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://www.appen.com/privacy-statement/
  contact:
    email: help@appen.com
servers:
- url: https://api.appen.com/v1
  description: Production Server
tags:
- name: Workflow Filter Rules
  description: Rules for routing data
paths:
  /step_routes/{route_id}/filter_rules:
    parameters:
    - $ref: '#/components/parameters/route_id_path'
    post:
      tags:
      - Workflow Filter Rules
      summary: Create a FilterRule for the step
      description: 'Create a configuration object for filtering data moving between steps. FilterRules determine whether the output of a step is qualified for forwarding to a destination step.

        Think of the `route` as a _pipe_ between the steps'' input and output ''pools'' and the filter rule as filter that only allows data "particles" of a certain size or shape through.'
      requestBody:
        $ref: '#/components/requestBodies/FilterRule'
      responses:
        '201':
          description: Rule created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterRule'
        '404':
          description: Route specified by id param not found in the database or does not belong to the customer.
        '422':
          description: Unprocessable Entity. A request parameter was malformed or missing.
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    example:
                    - comparison_operation must be present
      operationId: postStepRoutesByRouteIdFilterRules
      x-operation-id-source: derived
    get:
      tags:
      - Workflow Filter Rules
      summary: View the list of filter rules associated with a Route
      description: Displays a list of filter rules for a particular Route within a Workflow.
      responses:
        '200':
          description: OK - List of filter rules for the route.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FilterRule'
        '404':
          description: Route specified by id param not found in the database or does not belong to the customer.
      operationId: getStepRoutesByRouteIdFilterRules
      x-operation-id-source: derived
  /step_routes/{route_id}/filter_rules/{rule_id}:
    parameters:
    - $ref: '#/components/parameters/route_id_path'
    - $ref: '#/components/parameters/rule_id_path'
    patch:
      tags:
      - Workflow Filter Rules
      summary: Update a Rule associated with a Route
      description: Update the **FilterRule** record that configures some or all of the filtering of data between two **Steps**.
      requestBody:
        $ref: '#/components/requestBodies/FilterRule'
      responses:
        '200':
          description: Rule updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterRule'
        '404':
          description: Route or Filter Rule specified by id params not found in the database or does not belong to the customer.
        '422':
          description: Unprocessable Entity. A request parameter was malformed or missing.
          content:
            application/json:
              schema:
                properties:
                  errors:
                    type: array
                    example:
                    - comparison_operation must be present
      operationId: patchStepRoutesByRouteIdFilterRulesByRuleId
      x-operation-id-source: derived
    delete:
      tags:
      - Workflow Filter Rules
      summary: Delete a rule associated with a Route
      description: Delete the **FilterRule** record that configures some or all of the filtering of data between two **Steps**.
      parameters:
      - $ref: '#/components/parameters/route_id_path'
      - $ref: '#/components/parameters/rule_id_path'
      responses:
        '200':
          description: Filter Rule deleted.
        '404':
          description: Route or Filter Rule specified by id params not found in the database or does not belong to the customer.
      operationId: deleteStepRoutesByRouteIdFilterRulesByRuleId
      x-operation-id-source: derived
components:
  schemas:
    FilterRule:
      type: object
      required:
      - comparison_field
      - comparison_value
      - comparison_operation
      - rule_connector
      properties:
        id:
          type: integer
          example: 956
          readOnly: true
        comparison_field:
          type: string
          example: img_is_cat
        comparison_operation:
          type: string
          enum:
          - ==
          - <
          - '>'
          - '!='
          - =~
          - <=
          - '>='
          example: ==
        comparison_value:
          type: string
          example: 'true'
        rule_connector:
          type: string
          enum:
          - all
          - and
          - or
          - rnd
          - csp
          - els
          example: and
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
  requestBodies:
    FilterRule:
      content:
        application/json:
          schema:
            type: object
            properties:
              filter_rule:
                type: object
                required:
                - comparison_field
                - comparison_value
                - comparison_operation
                - rule_connector
                properties:
                  id:
                    type: integer
                    example: 956
                    readOnly: true
                  comparison_field:
                    type: string
                    example: img_is_cat
                  comparison_operation:
                    type: string
                    enum:
                    - ==
                    - <
                    - '>'
                    - '!='
                    - =~
                    - <=
                    - '>='
                    example: ==
                  comparison_value:
                    type: string
                    example: 'true'
                  rule_connector:
                    type: string
                    enum:
                    - all
                    - and
                    - or
                    - rnd
                    - csp
                    - els
                    example: and
  parameters:
    rule_id_path:
      name: rule_id
      in: path
      required: true
      description: Filter Rule database ID
      schema:
        type: integer
      example: 4567
    route_id_path:
      name: route_id
      in: path
      required: true
      description: Step Route database ID
      schema:
        type: integer
      example: 3456