Piece Schema

{
  "id": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "logoUrl": "<string>",
  "description": "<string>",
  "projectId": "<string>",
  "authors": [
    "<string>"
  ],
  "platformId": "<string>",
  "directoryPath": "<string>",
  "auth": {
    "displayName": "<string>",
    "description": "<string>",
    "username": {
      "displayName": "<string>",
      "description": "<string>"
    },
    "password": {
      "displayName": "<string>",
      "description": "<string>"
    },
    "type": "BASIC_AUTH",
    "required": true,
    "defaultValue": "<any>"
  },
  "version": "<string>",
  "categories": [
    "ARTIFICIAL_INTELLIGENCE"
  ],
  "minimumSupportedRelease": "<string>",
  "maximumSupportedRelease": "<string>",
  "actions": {},
  "triggers": {}
}

The schema is of type object.

List Flows Runs Install Piece

Get Started

Endpoints