API referenceAdmin APISyntic CodePluginsAdd a plugin

Add a plugin

⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/organizations/plugins

Add 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

HeaderRequiredValue
AuthorizationYesBearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys.
syntic-betaYes, while in previewadmin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.
Content-TypeYesapplication/json
Idempotency-KeyNoUp to 255 characters. Retrying with the same key within 24 hours returns the first result instead of acting twice. See Idempotency.

Body parameters

ParameterTypeRequiredNotes
file_idstringYesThe uploaded zip, up to 50 MB.
policystringNorequired, available (default) or blocked.
workspace_idsarray of stringsNoRestrict 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"
}
FieldTypeDescription
idstringStarts with plg_.
sourceobjectupload for bundles sent to this API, or marketplace with the marketplace_id it came from.
policystringrequired (installed for everyone and cannot be turned off), available (members may install it), or blocked (cannot be installed, even from a marketplace).
workspace_idsarray or nullLimit the policy to members of these workspaces; null means the whole organization.
latest_versionstringSemantic 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:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
400invalid_request_errorinvalid_manifestplugin.json is missing, malformed, or its name is not lowercase letters, digits and -.
400invalid_request_errorbundle_rejectedThe scan found executable content outside the declared hooks or a file over 10 MB.
409conflict_errorplugin_existsA plugin with this name exists; add a version to it instead.
401authentication_errorinvalid_api_keyThe admin key is missing, unknown, revoked or expired.
403permission_erroradmin_key_requiredAn inference key was used.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?