Chorus connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. 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>

What you can do

Connect this agent connector to let your agent:

• Search users — Search Chorus users by free-text query, e.g
• List users, teams, conversations — List users in the Chorus account, with optional team or role filters
• Get user, team, engagement — Retrieve a single Chorus user by ID
• Filter engagements — Search Chorus engagements (calls, meetings, and dialer activity) matching the given type, participant, outcome, and date-range criteria

Common workflows

Proxy API call

Node.js

const result = await actions.request({
  connectionName: 'chorus',
  identifier: 'user_123',
  path: '/v1/users/me',
  method: 'GET',
});
console.log(result);

Python

result = actions.request(
    connection_name='chorus',
    identifier='user_123',
    path="/v1/users/me",
    method="GET"
)
print(result)

Execute a tool

Node.js

const result = await actions.executeTool({
  connector: 'chorus',
  identifier: 'user_123',
  toolName: 'chorus_list',
  toolInput: {},
});
console.log(result);

Python

result = actions.execute_tool(
    tool_input={},
    tool_name='chorus_list',
    connection_name='chorus',
    identifier='user_123',
)
print(result)

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

chorus_conversation_get#Retrieve a single Chorus conversation by ID, including transcript, tracker matches, participants, linked CRM account/deal, recording details, and engagement metrics.1 param▾

Retrieve a single Chorus conversation by ID, including transcript, tracker matches, participants, linked CRM account/deal, recording details, and engagement metrics.

NameTypeRequiredDescription

conversation_idstringrequiredUnique identifier of the conversation.

chorus_conversations_list#List or search Chorus conversations (calls and meetings), with optional date range, participant, team, and tracker filters.7 params▾

List or search Chorus conversations (calls and meetings), with optional date range, participant, team, and tracker filters.

NameTypeRequiredDescription

end_datestringoptionalEnd of the date-time range for filtering conversations (ISO 8601).

page_sizeintegeroptionalNumber of results per page.

participant_emailstringoptionalFilter conversations by participant email address.

qstringoptionalFree-text search query.

start_datestringoptionalStart of the date-time range for filtering conversations (ISO 8601).

team_idstringoptionalFilter conversations by team ID.

tracker_namestringoptionalFilter conversations by tracker name.

chorus_engagement_get#Retrieve a single Chorus engagement by ID, including type, date, participants, duration, and outcome.1 param▾

Retrieve a single Chorus engagement by ID, including type, date, participants, duration, and outcome.

NameTypeRequiredDescription

engagement_idstringrequiredUnique identifier of the engagement.

chorus_engagements_filter#Search Chorus engagements (calls, meetings, and dialer activity) matching the given type, participant, outcome, and date-range criteria.6 params▾

Search Chorus engagements (calls, meetings, and dialer activity) matching the given type, participant, outcome, and date-range criteria.

NameTypeRequiredDescription

end_datestringoptionalEnd of the date-time range for filtering engagements (ISO 8601).

outcomestringoptionalFilter engagements by outcome.

page_sizeintegeroptionalNumber of results per page.

participant_emailsarrayoptionalArray of participant email addresses to filter by.

start_datestringoptionalStart of the date-time range for filtering engagements (ISO 8601).

typestringoptionalFilter engagements by type, e.g. MEETING or CALL.

chorus_team_get#Retrieve a single Chorus team by ID, including its member list.1 param▾

Retrieve a single Chorus team by ID, including its member list.

NameTypeRequiredDescription

team_idstringrequiredUnique identifier of the team.

chorus_teams_list#List teams configured in the Chorus account.1 param▾

List teams configured in the Chorus account.

NameTypeRequiredDescription

page_sizeintegeroptionalNumber of results per page.

chorus_user_get#Retrieve a single Chorus user by ID.1 param▾

Retrieve a single Chorus user by ID.

NameTypeRequiredDescription

user_idstringrequiredUnique identifier of the user.

chorus_users_list#List users in the Chorus account, with optional team or role filters.3 params▾

List users in the Chorus account, with optional team or role filters.

NameTypeRequiredDescription

page_sizeintegeroptionalNumber of results per page.

rolestringoptionalFilter users by role.

team_idstringoptionalFilter users by team ID.

chorus_users_search#Search Chorus users by free-text query, e.g. matching name or email.2 params▾

Search Chorus users by free-text query, e.g. matching name or email.

NameTypeRequiredDescription

qstringrequiredFree-text search query.

page_sizeintegeroptionalNumber of results per page.