Skip to main content
POST
/
v1
/
pieces
Add a piece to a platform
curl --request POST \
  --url https://cloud.activepieces.com/api/v1/pieces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "packageType": "ARCHIVE",
  "scope": "PLATFORM",
  "pieceName": "<string>",
  "pieceVersion": "<string>",
  "pieceArchive": {
    "filename": "<string>",
    "data": "<unknown>",
    "type": "file",
    "mimetype": "<string>"
  }
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://www.activepieces.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json

Private Piece

​
packageType
enum<string>
required
Available options:
ARCHIVE
​
scope
enum<string>
required
Available options:
PLATFORM
​
pieceName
string
required
Minimum string length: 1
​
pieceVersion
string
required
Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
​
pieceArchive
object
required

Response

201 - application/json

Default Response

The response is of type object.