Add a plugin
⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/organizations/pluginsAdd a Syntic Code plugin to the organization’s catalog from a bundle you already uploaded with the Files API (purpose plugin). The bundle is a zip with a plugin.json manifest at its root; it is scanned before it can be installed and the plugin starts in policy available unless you say otherwise.
For how this fits into a full workflow, see Syntic Code plugins.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | admin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Content-Type | Yes | application/json |
Idempotency-Key | No | Up to 255 characters. Retrying with the same key within 24 hours returns the first result instead of acting twice. See Idempotency. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
file_id | string | Yes | The uploaded zip, up to 50 MB. |
policy | string | No | required, available (default) or blocked. |
workspace_ids | array of strings | No | Restrict to members of these workspaces. |
Response
201 Created, Content-Type: application/json
{
"id": "plg_01JCN1P3R5T7V9X1Z3B5",
"type": "plugin",
"name": "acme-review-rules",
"display_name": "Acme code review rules",
"source": {
"kind": "upload"
},
"latest_version": "1.4.0",
"policy": "required",
"workspace_ids": null,
"description": "House style checks and the /review command for Syntic Code.",
"created_at": "2026-09-12T10:00:00Z",
"updated_at": "2026-11-02T10:00:00Z"
}| Field | Type | Description |
|---|---|---|
id | string | Starts with plg_. |
source | object | upload for bundles sent to this API, or marketplace with the marketplace_id it came from. |
policy | string | required (installed for everyone and cannot be turned off), available (members may install it), or blocked (cannot be installed, even from a marketplace). |
workspace_ids | array or null | Limit the policy to members of these workspaces; null means the whole organization. |
latest_version | string | Semantic version members receive. |
Examples
curl -sS "https://app.syntic.ai/v1/organizations/plugins" \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01" \
-H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
-H "Content-Type: application/json" \
-d '{
"file_id": "file_01JC3D5F7H9K1M3P5R7T",
"policy": "required"
}'Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 400 | invalid_request_error | invalid_manifest | plugin.json is missing, malformed, or its name is not lowercase letters, digits and -. |
| 400 | invalid_request_error | bundle_rejected | The scan found executable content outside the declared hooks or a file over 10 MB. |
| 409 | conflict_error | plugin_exists | A plugin with this name exists; add a version to it instead. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?