> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Coassemble

The Coassemble connector lets your AI agent act in each user's Coassemble account. Each user connects their own Coassemble API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 56 tools.

**Authentication:** API Key
**Categories:** Productivity, AI
**Tools:** 56: 24 read, 23 write, 9 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=COASSEMBLE)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Coassemble connection

   In **AgentKit > Connections**, create a Coassemble connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'coassemble'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Coassemble:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'coassemble_allowances_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "coassemble"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Coassemble:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="coassemble_allowances_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Coassemble credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'coassemble_allowances_get',
  toolInput: {},
  connector: 'coassemble',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="coassemble_allowances_get",
    tool_input={},
    connection_name="coassemble",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `coassemble_allowances_get`

Get Workspace Allowances · Read-only

Get the workspace's AI allowances and usage, such as narration characters and image generations.
Returns each allowance's limit and use.
Use coassemble_client_usage_list for per-client usage.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `coassemble_client_allowances_get`

Get Client AI Allowances · Read-only

Get one client's AI caps and usage.
Returns narration and image caps and usage.
Use coassemble_client_caps_update to change caps.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your identifier for the client. Example: user_123.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_client_default_caps_get`

Get Default Client AI Caps · Read-only

Get the default AI caps applied to new clients.
Returns clientCapsEnabled and the default narration and image caps.
Use coassemble_client_default_caps_update to change them.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `coassemble_client_get`

Get Client · Read-only

Get one client by its identifier.
Returns the client's identifier and metadata.
Use coassemble_client_update to change metadata.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your identifier for the client. Example: user_123.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_client_usage_list`

List Client Usage · Read-only

List AI usage per client over a date range (up to 366 days).
Returns per-client metric usage, paged.
Use coassemble_client_allowances_get for one client's caps.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end` (`string`, optional): End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.
- `start` (`string`, optional): Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.

Example input: `{}`

### `coassemble_clients_list`

List Clients · Read-only

List the clients (tenants) in the workspace.
Returns each client's identifier, metadata and created date.
Use a client identifier to scope other tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.

Example input: `{}`

### `coassemble_collection_get`

Get Collection · Read-only

Get one collection with its courses.
Returns the collection's title, description, courses and share settings.
Use coassemble_collection_update to change it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Collection ID, from coassemble_collections_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_collection_tracking_get`

Get Collection Tracking · Read-only

Get one collection tracking record.
Returns the learner, collection, progress and timestamps.
Use an id from coassemble_collection_trackings_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Collection tracking ID. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_collection_trackings_list`

List Collection Trackings · Read-only

List learner progress records for a collection.
Returns each tracking's learner, progress, completion and timestamps.
Use coassemble_collection_tracking_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Collection ID, from coassemble_collections_list. Example: 1234.
- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `end` (`string`, optional): End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
- `identifier` (`string`, optional): Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.
- `start` (`string`, optional): Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.

Example input: `{"id":1234}`

### `coassemble_collections_list`

List Collections · Read-only

List course collections, optionally for one user or client.
Returns each collection's id, title, description, courses and share settings.
Use coassemble_collection_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `deleted` (`boolean`, optional): true also returns soft-deleted items. Defaults to false. Example: false.
- `identifier` (`string`, optional): Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.

Example input: `{}`

### `coassemble_course_content_get`

Get Course Content · Read-only

Get the full content of a course: its screens and their blocks.
Returns the course with every screen's type, title and content.
Use this to read or summarize what a course teaches.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `identifier` (`string`, optional): Your stable identifier for the end user (author or learner) in your own system. Example: user_123.

Example input: `{"id":"<id>"}`

### `coassemble_course_get`

Get Course · Read-only

Get one course by ID.
Returns the course's title, description, theme, owner, language, publish state and settings.
Use coassemble_course_content_get for the screens.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `identifier` (`string`, optional): Your stable identifier for the end user (author or learner) in your own system. Example: user_123.

Example input: `{"id":"<id>"}`

### `coassemble_course_trackings_list`

List Course Trackings · Read-only

List learner progress records for a course, optionally for one user or client and date range.
Returns each tracking's learner, progress, score, completion and timestamps.
Use coassemble_tracking_get for one record.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `end` (`string`, optional): End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
- `identifier` (`string`, optional): Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.
- `start` (`string`, optional): Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.

Example input: `{"id":1234}`

### `coassemble_courses_list`

List Courses · Read-only

List the workspace's courses, optionally for one user or client or by title.
Returns each course's id, title, description, image, status, owner identifiers, language and timeEstimateMinutes.
Use coassemble_course_get for one course and coassemble_course_content_get for its screens.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `deleted` (`boolean`, optional): true also returns soft-deleted items. Defaults to false. Example: false.
- `identifier` (`string`, optional): Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.
- `title` (`string`, optional): Only courses whose title matches. Example: Workplace Safety.

Example input: `{}`

### `coassemble_layouts_list`

List Screen Layouts · Read-only

List the catalog of screen layouts.
Returns each layout's id, name and screen type.
Use a layout id in coassemble_screen_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `coassemble_screen_trackings_list`

List Screen Trackings · Read-only

List per-screen learner responses and progress for a course.
Returns screen-level tracking records with answers and timestamps.
Use this for question-level reporting.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Course ID. Example: 1234.
- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `end` (`string`, optional): End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
- `identifier` (`string`, optional): Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.
- `start` (`string`, optional): Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.

Example input: `{"id":1234}`

### `coassemble_theme_get`

Get Theme · Read-only

Get one theme.
Returns its name, fonts, colours, logo and config.
Use coassemble_theme_update to change it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Theme ID, from coassemble_themes_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_themes_list`

List Themes · Read-only

List the workspace's themes.
Returns each theme's id, name, fonts, colours, logo and default flag.
Use a theme id on courses and collections.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.

Example input: `{}`

### `coassemble_tracking_get`

Get Tracking · Read-only

Get one course tracking record.
Returns the learner, course, progress, score, completion and timestamps.
Use a tracking id from the list tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Tracking ID. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_translations_list`

List Course Translations · Read-only

List a course's translations.
Returns each language with its status and whether it is the default.
Use coassemble_translation_create to add a language.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_user_get`

Get User · Read-only

Get one end user by identifier.
Returns the user's identifier, client, name, avatar and metadata.
Use coassemble_user_update to change it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your identifier for the user. Example: user_123.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_user_trackings_list`

List User Trackings · Read-only

List every course progress record of one learner.
Returns each tracking's course, progress, score and completion.
Use coassemble_course_trackings_list for a course view.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `end` (`string`, optional): End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.
- `start` (`string`, optional): Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_users_list`

List Users · Read-only

List the end users (authors and learners) known to the workspace, optionally for one client.
Returns each user's identifier, client, name, avatar and metadata.
Use coassemble_user_trackings_list for a user's progress.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `length` (`integer`, optional): Items per page. Defaults to 100. Example: 50.
- `page` (`integer`, optional): Page number, starting at 0. Defaults to 0. Example: 0.

Example input: `{}`

### `coassemble_webhooks_list`

List Webhook Endpoints · Read-only

List the workspace's webhook endpoints.
Returns each endpoint's id, URL, events, data modes and enabled flag.
Use coassemble_webhook_create to add one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `coassemble_client_caps_update`

Update Client AI Caps · Write

Set a client's monthly AI caps for narration characters and image generations.
Returns the client's caps.
0 stops that generation; leave empty for no change.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your identifier for the client. Example: user_123.
- `image_usage_limit` (`integer`, optional): Image generations per month; null = no cap. Zero stops image generation. Example: 200.
- `narration_usage_limit` (`integer`, optional): Characters per month; null = no cap. Zero stops narration generation. Example: 50000.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_client_default_caps_update`

Update Default Client AI Caps · Write

Change the default AI caps for new clients.
Returns the new defaults.
Existing clients keep their caps.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_caps_enabled` (`boolean`, optional): Whether per-client AI caps apply to new clients. Example: true.
- `image_usage_limit` (`integer`, optional): Image usage limit. Example: 200.
- `narration_usage_limit` (`integer`, optional): Narration usage limit. Example: 50000.

Example input: `{}`

### `coassemble_client_update`

Update Client · Write

Replace a client's metadata.
Returns the updated client.
Use coassemble_client_get first.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your identifier for the client. Example: user_123.
- `metadata` (`object`, optional): Arbitrary metadata to attach to the client. Example: {"plan": "enterprise"}

Example input: `{"identifier":"<identifier>"}`

### `coassemble_collection_create`

Create Collection · Write

Create a collection that groups courses in a set order, with optional share-link access rules.
Returns the created collection.
Share-link gates do not apply to embeds.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `title` (`string`, required): Title shown to learners. Example: Workplace Safety.
- `client_identifier` (`string`, optional): The client this collection belongs to. Example: client_123.
- `course_ids` (`array`, optional): Initial course IDs to include, in display order. Example: [1234, 1235]
- `description` (`string`, optional): Description shown on the collection landing screen. Example: Core safety training for all staff.
- `domain` (`boolean`, optional): Share-link gate: only learners on approved email domains can open the collection share link. Does not apply to embeddables. Example: false.
- `domains` (`array`, optional): Share-link gate: approved email domains for the collection share link. Does not apply to embeddables. Example: ["example.com"]
- `emails` (`array`, optional): Share-link gate: invited learner emails for the collection share link. Does not apply to embeddables. Example: ["learner@example.com"]
- `identified` (`boolean`, optional): Share-link gate: learners must identify (typically by email) before opening the collection share link. Does not apply to embeddables. Example: false.
- `identifier` (`string`, optional): Your stable identifier for the collection owner. Example: user_123.
- `private` (`boolean`, optional): Share-link gate: only invited emails can open the collection share link. Does not apply to embeddables. Example: false.
- `theme_id` (`integer`, optional): Theme ID applied to the collection. Example: 42.

Example input: `{"title":"<title>"}`

### `coassemble_collection_restore`

Restore Collection · Write

Restore a soft-deleted collection.
Returns the collection.
Use coassemble_collections_list with deleted true to find it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Collection ID, from coassemble_collections_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_collection_update`

Update Collection · Write

Update a collection's title, description, theme, owner or share-link access rules.
Returns the updated collection.
Use coassemble_collection_get to read it first.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Collection ID, from coassemble_collections_list. Example: 1234.
- `client_identifier` (`string`, optional): The client this collection belongs to. Example: client_123.
- `description` (`string`, optional): Description shown on the collection landing screen. Example: Core safety training for all staff.
- `domain` (`boolean`, optional): Share-link gate: only learners on approved email domains can open the collection share link. Does not apply to embeddables. Example: false.
- `domains` (`array`, optional): Share-link gate: approved email domains for the collection share link. Does not apply to embeddables. Example: ["example.com"]
- `emails` (`array`, optional): Share-link gate: invited learner emails for the collection share link. Does not apply to embeddables. Example: ["learner@example.com"]
- `identified` (`boolean`, optional): Share-link gate: learners must identify (typically by email) before opening the collection share link. Does not apply to embeddables. Example: false.
- `identifier` (`string`, optional): Your stable identifier for the collection owner. Example: user_123.
- `private` (`boolean`, optional): Share-link gate: only invited emails can open the collection share link. Does not apply to embeddables. Example: false.
- `theme_id` (`integer`, optional): Theme ID applied to the collection. Example: 42.
- `title` (`string`, optional): Title shown to learners. Example: Workplace Safety.

Example input: `{"id":"<id>"}`

### `coassemble_course_duplicate`

Duplicate Course · Write

Copy a course, optionally into another user's or client's ownership.
Returns the new course.
Use coassemble_course_get to read the copy.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `client_identifier` (`string`, optional): Override client identifier on the duplicate. Example: client_123.
- `identifier` (`string`, optional): Override identifier on the duplicate. Example: user_123.

Example input: `{"id":"<id>"}`

### `coassemble_course_generate`

Generate Course · Write

Generate a course with AI from a topic, audience, familiarity, tone and approximate screen count.
Returns the new course.
Uses AI allowance. Use coassemble_course_generate_agent to ground the course in documents.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `audience` (`string`, required): Who the course is for (e.g. "new hires"). Example: new hires.
- `familiarity` (`string`, required): How familiar the audience is with the topic (e.g. "beginner"). Example: beginner.
- `identifier` (`string`, required): Your stable identifier for the course owner. Example: user_123.
- `prompt` (`string`, required): The topic or learning objective to generate a course from. Example: Create a short onboarding course about our expense policy.
- `screen_count` (`integer`, required): Approximate number of screens to generate. Example: 8.
- `tone` (`string`, required): Tone of voice for the generated content (e.g. "professional"). Example: professional.
- `client_identifier` (`string`, optional): The client this course belongs to. Example: client_123.

Example input: `{"audience":"new hires","familiarity":"beginner","identifier":"<identifier>","prompt":"<prompt>","screen_count":8,"tone":"professional"}`

### `coassemble_course_generate_agent`

Generate Course with Agent · Write

Generate a full course with Coassemble's AI create-course agent from a prompt and optional source documents, outcomes, audience, tone, length and assessments.
Returns the generated course (or its generation job) with its id.
Uses AI allowance. Use coassemble_course_generate for the simpler prompt-only generator.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `identifier` (`string`, required): Your stable identifier for the course owner. Example: user_123.
- `assessment` (`array`, optional): Assessment opt-ins, such as formative knowledge checks or a summative quiz. Defaults to formative knowledge checks only. Example: ["formative"]
- `audience` (`string`, optional): Who the course is for. Example: new hires.
- `client_identifier` (`string`, optional): The client this course belongs to. Example: client_123.
- `documents` (`array`, optional): Source documents to ground the course in, each an object with the document's url. Example: [{"url": "https://example.com/expense-policy.pdf"}]
- `fidelity_level` (`string`, optional): How closely to follow the source documents: verbatim, structured or adaptive. Example: structured. One of: `verbatim`, `structured`, `adaptive`.
- `folder_id` (`integer`, optional): Folder ID for the generated course. Example: 88.
- `language` (`string`, optional): Language for the course content. Example: en.
- `learning_outcomes` (`array`, optional): Learning outcomes the course should cover. Example: ["Submit an expense claim", "Know the spending limits"]
- `prompt` (`string`, optional): The topic, learning objective, or source brief for the course. Example: Create a short onboarding course about our expense policy.
- `selected_images` (`array`, optional): Document image URLs to include with structured or verbatim generation, or ["all"] for every extracted image. Example: ["https://example.com/diagram.png"]
- `time_estimate_minutes` (`integer`, optional): Target course duration in minutes. Example: 15.
- `tone` (`string`, optional): Tone of voice for the generated course. Example: professional.
- `use_brand_voice` (`boolean`, optional): Whether configured brand voice should be applied. Example: true.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_course_publish`

Publish Course · Write

Publish a course's draft so learners see the latest changes.
Returns the published course.
Use coassemble_course_revert to discard draft changes instead.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_course_quiz_generate`

Generate Course Quiz · Write

Generate quiz questions in a course with AI, optionally scored with a passing grade.
Returns the generated quiz screens.
Uses AI allowance.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `content` (`string`, optional): Source content to draw questions from. Example: Expense claims must be filed within 30 days.
- `passing_grade` (`integer`, optional): Pass mark (percentage 0–100) when scored is true. Example: 80.
- `prompt` (`string`, optional): Prompt describing what the quiz should cover. Example: Create a short onboarding course about our expense policy.
- `question_count` (`integer`, optional): How many questions to generate. Example: 5.
- `question_types` (`array`, optional): Question types to use (subset of: multipleChoiceImg, multipleResponse, trueFalse, writeAnswer, dropDown, matchCorresponding, matchSequence). Example: ["multipleResponse", "trueFalse"]
- `scored` (`boolean`, optional): Whether the quiz contributes to a pass/fail grade. Example: true.

Example input: `{"id":"<id>"}`

### `coassemble_course_restore`

Restore Course · Write

Restore a soft-deleted course.
Returns the restored course.
Use coassemble_courses_list with deleted true to find deleted courses.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_course_screen_generate`

Generate Course Screen · Write

Generate a new screen in a course with AI from a prompt or source content.
Returns the generated screen.
Uses AI allowance.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `type` (`string`, required): Screen type to generate, such as content or a question type. Example: content.
- `content` (`string`, optional): Source content to summarise into the screen. Example: Expense claims must be filed within 30 days.
- `prompt` (`string`, optional): Prompt describing what the screen should cover. Example: Create a short onboarding course about our expense policy.
- `title` (`string`, optional): Title for the screen. Example: Workplace Safety.

Example input: `{"id":"<id>","type":"<type>"}`

### `coassemble_course_thumbnail_regenerate`

Regenerate Course Thumbnail · Write

Queue a new course card thumbnail image for a course.
Returns id, thumbnail, thumbnailRevision and queued.
Use after changing the course's title or cover.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_course_url_create`

Create Course Embed URL · Write

Get a signed URL that opens a course for a learner (view) or opens the course builder for an author (edit), for embedding in your app.
Returns the signed URL.
Use action view with a course id for learners; action edit without an id opens the builder to create a course.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `action` (`string`, required): view (learner) or edit (authoring). Example: view. One of: `view`, `edit`.
- `identifier` (`string`, required): Your stable user identifier. Example: user_123.
- `avatar` (`string`, optional): Avatar URL for the learner. Example: https://example.com/avatar.png.
- `client_identifier` (`string`, optional): The client this user belongs to. Example: client_123.
- `id` (`string`, optional): Course ID (required when action is view). Example: 1234.
- `name` (`string`, optional): Display name for the learner. Example: Alex Learner.
- `options` (`object`, optional): Extra embed options for the course player, such as flow, back, colorPrimary, translations, language, lockSteps, hideOutline or autoResume. Example: {"hideOutline": true, "autoResume": true}
- `theme_id` (`integer`, optional): Theme ID to render the embed with. Example: 42.

Example input: `{"action":"view","identifier":"<identifier>"}`

### `coassemble_screen_create`

Create Screen · Write

Create a screen from a catalog layout or screen type.
Returns the new screen.
Use coassemble_layouts_list for layout IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `client_identifier` (`string`, optional): The client this user belongs to. Example: client_123.
- `identifier` (`string`, optional): Your stable user identifier. Example: user_123.
- `layout_id` (`string`, optional): Catalog layout id from GET /layouts. Example: text-image-left.
- `title` (`string`, optional): Screen title. Example: Workplace Safety.
- `type` (`string`, optional): Screen type when not using a layout. Example: content.
- `type_id` (`integer`, optional): Screen type id when layoutId is omitted. Example: 3.

Example input: `{}`

### `coassemble_theme_create`

Create Theme · Write

Create a theme with fonts, colours and a logo.
Returns the created theme.
Pass logo_url to upload a logo from a URL.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Theme name. Example: Alex Learner.
- `colours` (`object`, optional): Colour palette (keyed by role). Example: {"primary": "#4F46E5"}
- `config` (`object`, optional): Additional theme configuration. Example: {}
- `fonts` (`object`, optional): Font settings ({ heading: { family }, body: { family } }). Example: {"heading": {"family": "Poppins"}, "body": {"family": "Roboto"}}
- `logo_id` (`integer`, optional): Asset ID of an existing logo in the same workspace and tenant, for example the logoId from a previous theme response or a logo uploaded in the app. To add a new logo from an image, send logoUrl instead. Example: 991.
- `logo_url` (`string`, optional): An https link to an image, or a base64 data: URL (data:image/png;base64,...). The server downloads and stores the image, creates a logo asset owned by the theme's workspace and tenant, and sets it as the theme's logo. Allowed types are PNG, JPEG, GIF and WebP, checked from the image itself, up to 50 MB. Send either logoId or logoUrl, not both. Example: https://example.com/logo.png.

Example input: `{"name":"<name>"}`

### `coassemble_theme_update`

Update Theme · Write

Update a theme's name, fonts, colours, logo or config, or make it the default.
Returns the updated theme.
Name is required on every update.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Theme ID, from coassemble_themes_list. Example: 1234.
- `name` (`string`, required): Theme name. Example: Alex Learner.
- `colours` (`object`, optional): Colour palette. Example: {"primary": "#4F46E5"}
- `config` (`object`, optional): Additional theme configuration. Example: {}
- `default` (`boolean`, optional): Whether this theme is the workspace default. Example: false.
- `fonts` (`object`, optional): Font settings. Example: {"heading": {"family": "Poppins"}, "body": {"family": "Roboto"}}
- `logo_id` (`integer`, optional): Asset ID of an existing logo in the same workspace and tenant, for example the logoId from a previous theme response or a logo uploaded in the app. To add a new logo from an image, send logoUrl instead. Example: 991.
- `logo_url` (`string`, optional): An https link to an image, or a base64 data: URL (data:image/png;base64,...). The server downloads and stores the image, creates a logo asset owned by the theme's workspace and tenant, and sets it as the theme's logo. Allowed types are PNG, JPEG, GIF and WebP, checked from the image itself, up to 50 MB. Send either logoId or logoUrl, not both. Example: https://example.com/logo.png.

Example input: `{"id":"<id>","name":"<name>"}`

### `coassemble_translation_create`

Translate Course · Write

Create a machine translation of a course into a language.
Returns the new translation.
Uses AI allowance. Use a language code such as fr or es.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `language` (`string`, required): Language code to translate into, such as fr. Example: fr.

Example input: `{"id":"<id>","language":"<language>"}`

### `coassemble_translation_default_set`

Set Default Translation · Write

Make a translation the course's default language.
Returns the result.
Use coassemble_translations_list for languages.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `language` (`string`, required): Language code, such as fr. Example: fr.

Example input: `{"id":"<id>","language":"<language>"}`

### `coassemble_translation_sync`

Sync Translation · Write

Re-sync a translation with the latest source course content.
Returns the result.
Run after editing the source course.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `language` (`string`, required): Language code, such as fr. Example: fr.

Example input: `{"id":"<id>","language":"<language>"}`

### `coassemble_user_update`

Update User · Write

Update an end user's name, avatar, client or metadata.
Returns the updated user.
Use coassemble_user_get first.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your identifier for the user. Example: user_123.
- `avatar` (`string`, optional): Avatar URL (shorthand for metadata.avatar). Example: https://example.com/avatar.png.
- `client_identifier` (`string`, optional): The client this user belongs to. Example: client_123.
- `metadata` (`object`, optional): Arbitrary metadata for the user. Replaces the existing metadata; the stored name and avatar are kept unless set here or by name/avatar. Example: {"plan": "enterprise"}
- `name` (`string`, optional): Display name (shorthand for metadata.name). Example: Alex Learner.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_webhook_create`

Create Webhook Endpoint · Write

Register an HTTPS URL to receive Coassemble events such as course.completed.
Returns the endpoint with its id and signing secret.
Store the secret to verify deliveries.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `events` (`array`, required): Event names to subscribe to, e.g. course.completed. Example: ["course.completed"]
- `url` (`string`, required): HTTPS URL webhook deliveries will be POSTed to. Example: https://example.com/webhooks/coassemble.
- `data_modes` (`array`, optional): Data to receive: production (live), test, or both. New endpoints default to both on workspaces restricted to test keys (Sandbox or API Test Mode add-on), otherwise production only. Example: ["production"]
- `enabled` (`boolean`, optional): Whether the webhook endpoint is active. Defaults to true. Example: true.

Example input: `{"events":["course.completed"],"url":"<url>"}`

### `coassemble_client_delete`

Delete Client · Destructive

Delete a client.
Returns the result.
This removes the client from the workspace.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your identifier for the client. Example: user_123.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_collection_delete`

Delete Collection · Destructive

Soft-delete a collection.
Returns the result.
Use coassemble_collection_restore to undo.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Collection ID, from coassemble_collections_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_course_delete`

Delete Course · Destructive

Soft-delete a course.
Returns the result.
Use coassemble_course_restore to undo.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_course_revert`

Revert Course · Destructive

Discard a course's unpublished draft changes and go back to the published version.
Returns the course.
This drops unpublished edits.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_theme_delete`

Delete Theme · Destructive

Delete a theme.
Returns the result.
Content using it falls back to the default theme.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Theme ID, from coassemble_themes_list. Example: 1234.

Example input: `{"id":"<id>"}`

### `coassemble_tracking_delete`

Delete Tracking · Destructive

Delete a learner's progress on a course so they start over.
Returns the result.
This cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): Course ID whose tracking to delete for the user. Example: 1234.
- `identifier` (`string`, required): Learner identifier whose tracking against this course should be deleted. Example: user_123.
- `client_identifier` (`string`, optional): Restrict deletion to a tenant-scoped learner. Example: client_123.

Example input: `{"id":1234,"identifier":"<identifier>"}`

### `coassemble_translation_delete`

Delete Translation · Destructive

Delete a course's translation in one language.
Returns the result.
The source language can't be deleted.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Course ID, from coassemble_courses_list. Example: 1234.
- `language` (`string`, required): Language code, such as fr. Example: fr.

Example input: `{"id":"<id>","language":"<language>"}`

### `coassemble_user_delete`

Delete User · Destructive

Delete an end user, and reallocate, delete or keep the courses they own.
Returns the result.
Set action reallocate with reallocate_to to hand courses to another user.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `identifier` (`string`, required): Your identifier for the user to delete. Example: user_123.
- `action` (`string`, optional): What to do with the user's courses: reallocate (to reallocate_to), delete, or ignore. Example: reallocate. One of: `reallocate`, `delete`, `ignore`.
- `client_identifier` (`string`, optional): Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
- `reallocate_to` (`string`, optional): When action is reallocate: the identifier of the user who receives the deleted user's content. Example: user_456.

Example input: `{"identifier":"<identifier>"}`

### `coassemble_webhook_delete`

Delete Webhook Endpoint · Destructive

Remove a webhook endpoint; deliveries stop and its signing secret is invalidated.
Returns the result.
Use coassemble_webhooks_list for IDs.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Webhook endpoint ID. Example: 1234.

Example input: `{"id":"<id>"}`

## Related

Other Productivity connectors ([all 203](/agentkit/connectors/?category=productivity)):

- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Workspace (DWD)](/agentkit/connectors/googledwd/): Scalekit connector, Service account, 100 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
