Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
What can you do with it?
Record, transcribe, and analyze sales calls and meetings with Chorus.ai, including retrieving current user information, listing conversations, getting conversation details with transcripts, creating comments on conversations, and managing playlists for comprehensive conversation intelligence and sales analytics.
How to use it?
Basic Command Structure
/your-chorusai-connection [action] [required-parameters] [optional-parameters]
Parameters
Required:
action - The operation to perform (get-current-user, list-conversations, get-conversation, create-comment, list-playlists)
Optional:
conversation-id - Chorus.ai conversation ID
comment-text - Comment text content
comment-timestamp - Timestamp for comment placement
comment-visibility - Comment visibility (team, private)
page-size - Number of items per page
page-number - Page number for pagination
Get Current User
Retrieve the current user’s Chorus.ai information
Parameters:
Example:
/your-chorusai-connection
action: get-current-user
Response:
{
"id": "user_123abc",
"email": "user@company.com",
"firstName": "John",
"lastName": "Doe",
"role": "admin",
"createdAt": "2023-01-15T08:30:00Z",
"updatedAt": "2024-01-20T14:25:33Z"
}
List Conversations
Retrieve a list of conversations with pagination
Parameters:
page-size (optional) - Number of conversations per page (default: 25)
page-number (optional) - Page number (default: 1)
Example:
/your-chorusai-connection
action: list-conversations
page-size: 25
page-number: 1
Response:
{
"conversations": [
{
"id": "conv_xyz789",
"title": "Sales Call with Acme Corp",
"startTime": "2024-02-01T15:00:00Z",
"duration": 3600,
"status": "completed",
"participants": [
{
"id": "user_123abc",
"name": "John Doe",
"email": "john@company.com",
"role": "host"
}
],
"metadata": {
"dealSize": "$50000",
"stage": "discovery"
}
}
],
"pagination": {
"totalCount": 150,
"pageSize": 25,
"currentPage": 1
}
}
Get Conversation
Retrieve detailed information for a specific conversation including transcript and insights
Parameters:
conversation-id (required) - Chorus.ai conversation ID
Example:
/your-chorusai-connection
action: get-conversation
conversation-id: conv_xyz789
Response:
{
"id": "conv_xyz789",
"title": "Sales Call with Acme Corp",
"startTime": "2024-02-01T15:00:00Z",
"endTime": "2024-02-01T16:00:00Z",
"duration": 3600,
"status": "completed",
"transcript": {
"segments": [
{
"id": "seg_001",
"speakerId": "user_123abc",
"speakerName": "John Doe",
"startTime": 0,
"endTime": 15,
"text": "Hi everyone, thanks for joining today's call."
}
]
},
"insights": {
"talkRatio": {
"rep": 0.4,
"customer": 0.6
},
"keywords": [
"pricing",
"implementation",
"timeline"
]
}
}
Add a comment to a specific conversation at a given timestamp
Parameters:
conversation-id (required) - Chorus.ai conversation ID
comment-text (required) - Comment text content
comment-timestamp (required) - Timestamp in seconds for comment placement
comment-visibility (optional) - Comment visibility (team, private, default: team)
Example:
/your-chorusai-connection
action: create-comment
conversation-id: conv_xyz789
comment-text: Great discovery of pain points at 15:30
comment-timestamp: 930
comment-visibility: team
Response:
{
"id": "comment_456def",
"text": "Great discovery of pain points at 15:30",
"timestamp": 930,
"visibility": "team",
"createdBy": "user_123abc",
"createdAt": "2024-02-01T16:30:00Z"
}
List Playlists
Retrieve a list of playlists for organizing conversations
Parameters:
page-size (optional) - Number of playlists per page (default: 10)
page-number (optional) - Page number (default: 1)
Example:
/your-chorusai-connection
action: list-playlists
page-size: 10
page-number: 1
Response:
{
"playlists": [
{
"id": "playlist_789ghi",
"name": "Best Discovery Calls Q1 2024",
"description": "Top performing discovery calls from Q1",
"createdBy": "user_123abc",
"createdAt": "2024-01-05T09:00:00Z",
"conversationCount": 12
}
],
"pagination": {
"totalCount": 5,
"pageSize": 10,
"currentPage": 1
}
}
Notes
Chorus.ai uses custom proxy integration through Paragon. Conversation IDs are alphanumeric identifiers for specific calls or meetings. Transcripts include speaker identification and timing information. Comments can be placed at specific timestamps within conversations. Talk ratio insights show speaking time distribution between participants. Keywords are automatically extracted from conversation content. Playlists help organize conversations by themes or criteria.