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.
- Tools
- 56
- What they doRead · write · destructive
- 24 · 23 · 924 read23 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Coassemble connection
In AgentKit > Connections, create a Coassemble connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'coassemble'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'coassemble_allowances_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "coassemble"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="coassemble_allowances_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Coassemble credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcoassemble_allowances_getGet the workspace's AI allowances and usage, such as narration characters and image generations.Read-onlyGet Workspace Allowances
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.
Inputs
This tool takes no inputs.
coassemble_client_allowances_getGet one client's AI caps and usage.Read-onlyGet Client AI Allowances
Get one client's AI caps and usage. Returns narration and image caps and usage. Use coassemble_client_caps_update to change caps.
Inputs
identifierstringrequired- Your identifier for the client. Example: user_123.
coassemble_client_default_caps_getGet the default AI caps applied to new clients.Read-onlyGet Default Client AI Caps
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.
Inputs
This tool takes no inputs.
coassemble_client_getGet one client by its identifier.Read-onlyGet Client
Get one client by its identifier. Returns the client's identifier and metadata. Use coassemble_client_update to change metadata.
Inputs
identifierstringrequired- Your identifier for the client. Example: user_123.
coassemble_client_usage_listList AI usage per client over a date range (up to 366 days).Read-onlyList Client Usage
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.
Inputs
endstring- End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
startstring- Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.
coassemble_clients_listList the clients (tenants) in the workspace.Read-onlyList Clients
List the clients (tenants) in the workspace. Returns each client's identifier, metadata and created date. Use a client identifier to scope other tools.
Inputs
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
coassemble_collection_getGet one collection with its courses.Read-onlyGet Collection
Get one collection with its courses. Returns the collection's title, description, courses and share settings. Use coassemble_collection_update to change it.
Inputs
idstringrequired- Collection ID, from coassemble_collections_list. Example: 1234.
coassemble_collection_tracking_getGet one collection tracking record.Read-onlyGet Collection Tracking
Get one collection tracking record. Returns the learner, collection, progress and timestamps. Use an id from coassemble_collection_trackings_list.
Inputs
idstringrequired- Collection tracking ID. Example: 1234.
coassemble_collection_trackings_listList learner progress records for a collection.Read-onlyList Collection Trackings
List learner progress records for a collection. Returns each tracking's learner, progress, completion and timestamps. Use coassemble_collection_tracking_get for one.
Inputs
idintegerrequired- Collection ID, from coassemble_collections_list. Example: 1234.
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
endstring- End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
identifierstring- Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
startstring- Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.
coassemble_collections_listList course collections, optionally for one user or client.Read-onlyList Collections
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.
Inputs
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
deletedboolean- true also returns soft-deleted items. Defaults to false. Example: false.
identifierstring- Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
coassemble_course_content_getGet the full content of a course: its screens and their blocks.Read-onlyGet Course Content
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.
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
identifierstring- Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
coassemble_course_getGet one course by ID.Read-onlyGet Course
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.
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
identifierstring- Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
coassemble_course_trackings_listList learner progress records for a course, optionally for one user or client and date range.Read-onlyList Course Trackings
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.
Inputs
idintegerrequired- Course ID, from coassemble_courses_list. Example: 1234.
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
endstring- End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
identifierstring- Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
startstring- Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.
coassemble_courses_listList the workspace's courses, optionally for one user or client or by title.Read-onlyList Courses
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.
Inputs
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
deletedboolean- true also returns soft-deleted items. Defaults to false. Example: false.
identifierstring- Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
titlestring- Only courses whose title matches. Example: Workplace Safety.
coassemble_layouts_listList the catalog of screen layouts.Read-onlyList Screen Layouts
List the catalog of screen layouts. Returns each layout's id, name and screen type. Use a layout id in coassemble_screen_create.
Inputs
This tool takes no inputs.
coassemble_screen_trackings_listList per-screen learner responses and progress for a course.Read-onlyList Screen Trackings
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.
Inputs
idintegerrequired- Course ID. Example: 1234.
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
endstring- End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
identifierstring- Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
startstring- Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.
coassemble_theme_getGet one theme.Read-onlyGet Theme
Get one theme. Returns its name, fonts, colours, logo and config. Use coassemble_theme_update to change it.
Inputs
idstringrequired- Theme ID, from coassemble_themes_list. Example: 1234.
coassemble_themes_listList the workspace's themes.Read-onlyList Themes
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.
Inputs
lengthinteger- Items per page. Defaults to 100. Example: 50.
coassemble_tracking_getGet one course tracking record.Read-onlyGet Tracking
Get one course tracking record. Returns the learner, course, progress, score, completion and timestamps. Use a tracking id from the list tools.
Inputs
idstringrequired- Tracking ID. Example: 1234.
coassemble_translations_listList a course's translations.Read-onlyList Course Translations
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.
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
coassemble_user_getGet one end user by identifier.Read-onlyGet User
Get one end user by identifier. Returns the user's identifier, client, name, avatar and metadata. Use coassemble_user_update to change it.
Inputs
identifierstringrequired- Your identifier for the user. Example: user_123.
coassemble_user_trackings_listList every course progress record of one learner.Read-onlyList User Trackings
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.
Inputs
identifierstringrequired- Your stable identifier for the end user (author or learner) in your own system. Example: user_123.
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
endstring- End of the date range, ISO 8601 date such as 2026-10-31. Example: 2026-10-31.
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
startstring- Start of the date range, ISO 8601 date such as 2026-10-01. Example: 2026-10-01.
coassemble_users_listList the end users (authors and learners) known to the workspace, optionally for one client.Read-onlyList Users
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.
Inputs
client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
lengthinteger- Items per page. Defaults to 100. Example: 50.
pageinteger- Page number, starting at 0. Defaults to 0. Example: 0.
coassemble_webhooks_listList the workspace's webhook endpoints.Read-onlyList Webhook Endpoints
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.
Inputs
This tool takes no inputs.
coassemble_client_caps_updateSet a client's monthly AI caps for narration characters and image generations.WriteUpdate Client AI Caps
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.
- Idempotent
Inputs
identifierstringrequired- Your identifier for the client. Example: user_123.
image_usage_limitinteger- Image generations per month; null = no cap. Zero stops image generation. Example: 200.
narration_usage_limitinteger- Characters per month; null = no cap. Zero stops narration generation. Example: 50000.
coassemble_client_default_caps_updateChange the default AI caps for new clients.WriteUpdate Default Client AI Caps
Change the default AI caps for new clients. Returns the new defaults. Existing clients keep their caps.
- Idempotent
Inputs
client_caps_enabledboolean- Whether per-client AI caps apply to new clients. Example: true.
image_usage_limitinteger- Image usage limit. Example: 200.
narration_usage_limitinteger- Narration usage limit. Example: 50000.
coassemble_client_updateReplace a client's metadata.WriteUpdate Client
Replace a client's metadata. Returns the updated client. Use coassemble_client_get first.
- Idempotent
Inputs
identifierstringrequired- Your identifier for the client. Example: user_123.
metadataobject- Arbitrary metadata to attach to the client. Example: {"plan": "enterprise"}
coassemble_collection_createCreate a collection that groups courses in a set order, with optional share-link access rules.WriteCreate Collection
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.
Inputs
titlestringrequired- Title shown to learners. Example: Workplace Safety.
client_identifierstring- The client this collection belongs to. Example: client_123.
course_idsarray- Initial course IDs to include, in display order. Example: [1234, 1235]
descriptionstring- Description shown on the collection landing screen. Example: Core safety training for all staff.
domainboolean- Share-link gate: only learners on approved email domains can open the collection share link. Does not apply to embeddables. Example: false.
domainsarray- Share-link gate: approved email domains for the collection share link. Does not apply to embeddables. Example: ["example.com"]
emailsarray- Share-link gate: invited learner emails for the collection share link. Does not apply to embeddables. Example: ["learner@example.com"]
identifiedboolean- Share-link gate: learners must identify (typically by email) before opening the collection share link. Does not apply to embeddables. Example: false.
identifierstring- Your stable identifier for the collection owner. Example: user_123.
privateboolean- Share-link gate: only invited emails can open the collection share link. Does not apply to embeddables. Example: false.
theme_idinteger- Theme ID applied to the collection. Example: 42.
coassemble_collection_restoreRestore a soft-deleted collection.WriteRestore Collection
Restore a soft-deleted collection. Returns the collection. Use coassemble_collections_list with deleted true to find it.
- Idempotent
Inputs
idstringrequired- Collection ID, from coassemble_collections_list. Example: 1234.
coassemble_collection_updateUpdate a collection's title, description, theme, owner or share-link access rules.WriteUpdate Collection
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.
- Idempotent
Inputs
idstringrequired- Collection ID, from coassemble_collections_list. Example: 1234.
client_identifierstring- The client this collection belongs to. Example: client_123.
descriptionstring- Description shown on the collection landing screen. Example: Core safety training for all staff.
domainboolean- Share-link gate: only learners on approved email domains can open the collection share link. Does not apply to embeddables. Example: false.
domainsarray- Share-link gate: approved email domains for the collection share link. Does not apply to embeddables. Example: ["example.com"]
emailsarray- Share-link gate: invited learner emails for the collection share link. Does not apply to embeddables. Example: ["learner@example.com"]
identifiedboolean- Share-link gate: learners must identify (typically by email) before opening the collection share link. Does not apply to embeddables. Example: false.
identifierstring- Your stable identifier for the collection owner. Example: user_123.
privateboolean- Share-link gate: only invited emails can open the collection share link. Does not apply to embeddables. Example: false.
theme_idinteger- Theme ID applied to the collection. Example: 42.
titlestring- Title shown to learners. Example: Workplace Safety.
coassemble_course_duplicateCopy a course, optionally into another user's or client's ownership.WriteDuplicate Course
Copy a course, optionally into another user's or client's ownership. Returns the new course. Use coassemble_course_get to read the copy.
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
client_identifierstring- Override client identifier on the duplicate. Example: client_123.
identifierstring- Override identifier on the duplicate. Example: user_123.
coassemble_course_generateGenerate a course with AI from a topic, audience, familiarity, tone and approximate screen count.WriteGenerate Course
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.
Inputs
audiencestringrequired- Who the course is for (e.g. "new hires"). Example: new hires.
familiaritystringrequired- How familiar the audience is with the topic (e.g. "beginner"). Example: beginner.
identifierstringrequired- Your stable identifier for the course owner. Example: user_123.
promptstringrequired- The topic or learning objective to generate a course from. Example: Create a short onboarding course about our expense policy.
screen_countintegerrequired- Approximate number of screens to generate. Example: 8.
tonestringrequired- Tone of voice for the generated content (e.g. "professional"). Example: professional.
client_identifierstring- The client this course belongs to. Example: client_123.
coassemble_course_generate_agentGenerate a full course with Coassemble's AI create-course agent from a prompt and optional source documents, outcomes, audience, tone, length and assessments.WriteGenerate Course with Agent
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.
Inputs
identifierstringrequired- Your stable identifier for the course owner. Example: user_123.
assessmentarray- Assessment opt-ins, such as formative knowledge checks or a summative quiz. Defaults to formative knowledge checks only. Example: ["formative"]
audiencestring- Who the course is for. Example: new hires.
client_identifierstring- The client this course belongs to. Example: client_123.
documentsarray- Source documents to ground the course in, each an object with the document's url. Example: [{"url": "https://example.com/expense-policy.pdf"}]
fidelity_levelstring- How closely to follow the source documents: verbatim, structured or adaptive. Example: structured.one of
verbatimstructuredadaptive folder_idinteger- Folder ID for the generated course. Example: 88.
languagestring- Language for the course content. Example: en.
learning_outcomesarray- Learning outcomes the course should cover. Example: ["Submit an expense claim", "Know the spending limits"]
promptstring- The topic, learning objective, or source brief for the course. Example: Create a short onboarding course about our expense policy.
selected_imagesarray- Document image URLs to include with structured or verbatim generation, or ["all"] for every extracted image. Example: ["https://example.com/diagram.png"]
time_estimate_minutesinteger- Target course duration in minutes. Example: 15.
tonestring- Tone of voice for the generated course. Example: professional.
use_brand_voiceboolean- Whether configured brand voice should be applied. Example: true.
coassemble_course_publishPublish a course's draft so learners see the latest changes.WritePublish Course
Publish a course's draft so learners see the latest changes. Returns the published course. Use coassemble_course_revert to discard draft changes instead.
- Idempotent
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
coassemble_course_quiz_generateGenerate quiz questions in a course with AI, optionally scored with a passing grade.WriteGenerate Course Quiz
Generate quiz questions in a course with AI, optionally scored with a passing grade. Returns the generated quiz screens. Uses AI allowance.
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
contentstring- Source content to draw questions from. Example: Expense claims must be filed within 30 days.
passing_gradeinteger- Pass mark (percentage 0–100) when scored is true. Example: 80.
promptstring- Prompt describing what the quiz should cover. Example: Create a short onboarding course about our expense policy.
question_countinteger- How many questions to generate. Example: 5.
question_typesarray- Question types to use (subset of: multipleChoiceImg, multipleResponse, trueFalse, writeAnswer, dropDown, matchCorresponding, matchSequence). Example: ["multipleResponse", "trueFalse"]
scoredboolean- Whether the quiz contributes to a pass/fail grade. Example: true.
coassemble_course_restoreRestore a soft-deleted course.WriteRestore Course
Restore a soft-deleted course. Returns the restored course. Use coassemble_courses_list with deleted true to find deleted courses.
- Idempotent
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
coassemble_course_screen_generateGenerate a new screen in a course with AI from a prompt or source content.WriteGenerate Course Screen
Generate a new screen in a course with AI from a prompt or source content. Returns the generated screen. Uses AI allowance.
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
typestringrequired- Screen type to generate, such as content or a question type. Example: content.
contentstring- Source content to summarise into the screen. Example: Expense claims must be filed within 30 days.
promptstring- Prompt describing what the screen should cover. Example: Create a short onboarding course about our expense policy.
titlestring- Title for the screen. Example: Workplace Safety.
coassemble_course_thumbnail_regenerateQueue a new course card thumbnail image for a course.WriteRegenerate Course Thumbnail
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.
- Idempotent
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
coassemble_course_url_createGet 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.WriteCreate Course Embed URL
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.
Inputs
actionstringrequired- view (learner) or edit (authoring). Example: view.one of
viewedit identifierstringrequired- Your stable user identifier. Example: user_123.
avatarstring- Avatar URL for the learner. Example: https://example.com/avatar.png.
client_identifierstring- The client this user belongs to. Example: client_123.
idstring- Course ID (required when action is view). Example: 1234.
namestring- Display name for the learner. Example: Alex Learner.
optionsobject- Extra embed options for the course player, such as flow, back, colorPrimary, translations, language, lockSteps, hideOutline or autoResume. Example: {"hideOutline": true, "autoResume": true}
theme_idinteger- Theme ID to render the embed with. Example: 42.
coassemble_screen_createCreate a screen from a catalog layout or screen type.WriteCreate Screen
Create a screen from a catalog layout or screen type. Returns the new screen. Use coassemble_layouts_list for layout IDs.
Inputs
client_identifierstring- The client this user belongs to. Example: client_123.
identifierstring- Your stable user identifier. Example: user_123.
layout_idstring- Catalog layout id from GET /layouts. Example: text-image-left.
titlestring- Screen title. Example: Workplace Safety.
typestring- Screen type when not using a layout. Example: content.
type_idinteger- Screen type id when layoutId is omitted. Example: 3.
coassemble_theme_createCreate a theme with fonts, colours and a logo.WriteCreate Theme
Create a theme with fonts, colours and a logo. Returns the created theme. Pass logo_url to upload a logo from a URL.
Inputs
namestringrequired- Theme name. Example: Alex Learner.
coloursobject- Colour palette (keyed by role). Example: {"primary": "#4F46E5"}
configobject- Additional theme configuration. Example: {}
fontsobject- Font settings ({ heading: { family }, body: { family } }). Example: {"heading": {"family": "Poppins"}, "body": {"family": "Roboto"}}
logo_idinteger- 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_urlstring- 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.
coassemble_theme_updateUpdate a theme's name, fonts, colours, logo or config, or make it the default.WriteUpdate Theme
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.
- Idempotent
Inputs
idstringrequired- Theme ID, from coassemble_themes_list. Example: 1234.
namestringrequired- Theme name. Example: Alex Learner.
coloursobject- Colour palette. Example: {"primary": "#4F46E5"}
configobject- Additional theme configuration. Example: {}
defaultboolean- Whether this theme is the workspace default. Example: false.
fontsobject- Font settings. Example: {"heading": {"family": "Poppins"}, "body": {"family": "Roboto"}}
logo_idinteger- 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_urlstring- 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.
coassemble_translation_createCreate a machine translation of a course into a language.WriteTranslate Course
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.
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
languagestringrequired- Language code to translate into, such as fr. Example: fr.
coassemble_translation_default_setMake a translation the course's default language.WriteSet Default Translation
Make a translation the course's default language. Returns the result. Use coassemble_translations_list for languages.
- Idempotent
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
languagestringrequired- Language code, such as fr. Example: fr.
coassemble_translation_syncRe-sync a translation with the latest source course content.WriteSync Translation
Re-sync a translation with the latest source course content. Returns the result. Run after editing the source course.
- Idempotent
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
languagestringrequired- Language code, such as fr. Example: fr.
coassemble_user_updateUpdate an end user's name, avatar, client or metadata.WriteUpdate User
Update an end user's name, avatar, client or metadata. Returns the updated user. Use coassemble_user_get first.
- Idempotent
Inputs
identifierstringrequired- Your identifier for the user. Example: user_123.
avatarstring- Avatar URL (shorthand for metadata.avatar). Example: https://example.com/avatar.png.
client_identifierstring- The client this user belongs to. Example: client_123.
metadataobject- 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"}
namestring- Display name (shorthand for metadata.name). Example: Alex Learner.
coassemble_webhook_createRegister an HTTPS URL to receive Coassemble events such as course.completed.WriteCreate Webhook Endpoint
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.
Inputs
eventsarrayrequired- Event names to subscribe to, e.g. course.completed. Example: ["course.completed"]
urlstringrequired- HTTPS URL webhook deliveries will be POSTed to. Example: https://example.com/webhooks/coassemble.
data_modesarray- 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"]
enabledboolean- Whether the webhook endpoint is active. Defaults to true. Example: true.
coassemble_client_deleteDelete a client.DestructiveDelete Client
Delete a client. Returns the result. This removes the client from the workspace.
- Idempotent
Inputs
identifierstringrequired- Your identifier for the client. Example: user_123.
coassemble_collection_deleteSoft-delete a collection.DestructiveDelete Collection
Soft-delete a collection. Returns the result. Use coassemble_collection_restore to undo.
- Idempotent
Inputs
idstringrequired- Collection ID, from coassemble_collections_list. Example: 1234.
coassemble_course_deleteSoft-delete a course.DestructiveDelete Course
Soft-delete a course. Returns the result. Use coassemble_course_restore to undo.
- Idempotent
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
coassemble_course_revertDiscard a course's unpublished draft changes and go back to the published version.DestructiveRevert Course
Discard a course's unpublished draft changes and go back to the published version. Returns the course. This drops unpublished edits.
- Idempotent
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
coassemble_theme_deleteDelete a theme.DestructiveDelete Theme
Delete a theme. Returns the result. Content using it falls back to the default theme.
- Idempotent
Inputs
idstringrequired- Theme ID, from coassemble_themes_list. Example: 1234.
coassemble_tracking_deleteDelete a learner's progress on a course so they start over.DestructiveDelete Tracking
Delete a learner's progress on a course so they start over. Returns the result. This cannot be undone.
- Idempotent
Inputs
idintegerrequired- Course ID whose tracking to delete for the user. Example: 1234.
identifierstringrequired- Learner identifier whose tracking against this course should be deleted. Example: user_123.
client_identifierstring- Restrict deletion to a tenant-scoped learner. Example: client_123.
coassemble_translation_deleteDelete a course's translation in one language.DestructiveDelete Translation
Delete a course's translation in one language. Returns the result. The source language can't be deleted.
- Idempotent
Inputs
idstringrequired- Course ID, from coassemble_courses_list. Example: 1234.
languagestringrequired- Language code, such as fr. Example: fr.
coassemble_user_deleteDelete an end user, and reallocate, delete or keep the courses they own.DestructiveDelete User
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.
- Idempotent
Inputs
identifierstringrequired- Your identifier for the user to delete. Example: user_123.
actionstring- What to do with the user's courses: reallocate (to reallocate_to), delete, or ignore. Example: reallocate.one of
reallocatedeleteignore client_identifierstring- Your identifier for the client (tenant) the user or content belongs to. Omit for the workspace default. Example: client_123.
reallocate_tostring- When action is reallocate: the identifier of the user who receives the deleted user's content. Example: user_456.
coassemble_webhook_deleteRemove a webhook endpoint; deliveries stop and its signing secret is invalidated.DestructiveDelete Webhook Endpoint
Remove a webhook endpoint; deliveries stop and its signing secret is invalidated. Returns the result. Use coassemble_webhooks_list for IDs.
- Idempotent
Inputs
idstringrequired- Webhook endpoint ID. Example: 1234.
No tools match.