Activepieces home pagelight logodark logo
  • GitHub
  • Pieces
  • Get Started
  • Get Started
Documentation
Develop Pieces
Embedding
API Reference
Deploy
Handbook
Get Started
  • Overview
Endpoints
  • Projects
  • User Invitations
  • Project Members
  • Connections
  • Flows
  • Flow Runs
  • Sample Data
  • Pieces
    • Piece Schema
    • POST
      Install Piece
  • Project Releases
  • Global Connections
  • Git Sync
  • Folders
  • Flow Templates
  • MCP Servers
Pieces

Piece Schema

The schema is of type object.

Suggest editsRaise issue
Get Sample DataInstall 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>",
  "i18n": {
    "nl": {},
    "en": {},
    "de": {},
    "it": {},
    "fr": {},
    "bg": {},
    "uk": {},
    "hu": {},
    "es": {},
    "ja": {},
    "id": {},
    "vi": {},
    "zh": {},
    "pt": {}
  },
  "actions": {},
  "triggers": {}
}
Assistant
Responses are generated using AI and may contain mistakes.