Activepieces home pagelight logodark logo
  • GitHub
  • Get Started
  • Get Started
  • Documentation
  • Deploy
  • Develop Pieces
  • Pieces
  • API
  • Discord
  • Get Started
    • Overview
    Endpoints
    • Projects
    • Project Members
    • Connections
    • Flows
    • Flow Runs
    • Pieces
      • Piece Schema
      • POST
        Install Piece
    • Git Sync
    Pieces

    Piece Schema

    The schema is of type object.

    Suggest editsRaise issue
    List Flows RunsInstall Piece
    websitegithubdiscord
    Powered by Mintlify
    Copy
    Ask AI
    {
      "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": {}
    }
    Assistant
    Responses are generated using AI and may contain mistakes.