---
title: "Install a connector: its origin, the vault per workspace role, and its tools [admin, owner or admin]"
method: POST
path: "/workspace-connectors"
tags: ["workspace-connectors"]
---

# Install a connector: its origin, the vault per workspace role, and its tools \[admin, owner or admin\]

`POST /workspace-connectors`

## Request

- Base URL: `https://api.agentsky.dev/v1`
- URL: `https://api.agentsky.dev/v1/workspace-connectors`
- Auth: HTTP bearer

The credentials live in the named vaults as environment_variable secrets bound to the origin's host; nothing here stores or returns a value. At most 20 connectors per workspace; 409 on a repeated kind and name; 422 for a vault outside the workspace.

## Request body

- CreateWorkspaceConnector
  - `kind` string, required: A short lowercase name for the service, e.g. crm
  - `name` string: Defaults to kind
  - `origin` string, uri, required: https, public host; the host the connector's credentials are sent to
  - `role_vaults` object, required: The vault (vlt_…) each workspace role exchanges its identity for; at least one role
    - `owner` string
    - `admin` string
    - `member` string
  - `tools` object[]: What the service offers, shown to agents that ask what the workspace has
    - `name` string, required
    - `description` string
    - `example` string

## Response `201`

Created

- object
  - `connector` WorkspaceConnector, required
    - `id` string, required
    - `kind` string, required
    - `name` string, required
    - `origin` string, required
    - `role_vaults` object, required: Public vault ids by workspace role; never a value
    - `tools` object[], required
      - `name` string, required
      - `description` string, required
      - `example` string, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `default`: Error — { error: { code, message } }

## Changes

- **2026-11-02** `e5e8f0229a99`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/agentsky/apis/agentsky-developer-api/changes/workspace-connectors/post.md)

---

[API](https://skmtc.dev/agentsky/apis/agentsky-developer-api.md) - [All operations](https://skmtc.dev/agentsky/apis/agentsky-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agentsky/apis/agentsky-developer-api/revisions/8280a065ef6a?raw)