Add a workspace member

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

Give an organization member access to a workspace with one of three roles: workspace_user (use the workspace and see usage), workspace_developer (also create their own keys and build agents) or workspace_admin (also manage members, every key, limits and settings).

For how this fits into a full workflow, see Workspaces.

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

Path parameters

ParameterTypeDescription
workspace_idstringThe workspace id, starting with wrkspc_.

Body parameters

ParameterTypeRequiredNotes
user_idstringYesSomeone who already belongs to the organization with active status.
rolestringYesworkspace_user, workspace_developer or workspace_admin.

Response

201 Created, Content-Type: application/json

{
  "type": "workspace_member",
  "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
  "user_id": "user_01J9Y0A2C4E6G8J0L2N4",
  "role": "workspace_developer",
  "added_at": "2026-11-02T10:00:00Z"
}

Examples

curl -sS https://app.syntic.ai/v1/organizations/workspaces/wrkspc_01JC0A2C4E6G8J0L2N4Q/members \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: admin-2026-11-01" \
  -H "Content-Type: application/json" \
  -d '{
      "user_id": "user_01J9Y0A2C4E6G8J0L2N4",
      "role": "workspace_developer"
    }'

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_roleUnknown workspace role.
404not_found_errorworkspace_not_foundNo workspace with that id in the organization.
404not_found_erroruser_not_foundNo such person in this organization (or, for workspace calls, in this workspace).
409conflict_erroralready_workspace_memberThe user is already in the workspace; change the role instead.
403permission_errorrole_requiredThe admin key’s creator does not have the role this needs.
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?