Skip to Content
Tools referenceRecordings

Recordings

ToolWhat it does
conversation_keyword_matchFind which saved contacts, or which external company email domains, were on the recorded calls where certain phrases were said - or not said - across the recordings the user can see.
recording_askAsk a question about what was said in one recording’s meeting, such as ‘what did they say about pricing’ or ‘did they mention a competitor’, answered from its transcript.
recording_create_followup_tasksCreate reviewed tasks from a recording’s follow-up suggestions.
recording_draft_followupCreate a follow-up email prefill from one recording; this sends nothing.
recording_getOpen one recording: who hosted and attended, when and how long, its AI outcome, next steps, objections, questions and decisions, talking-point hits, notes and who has access.
recording_searchSearch or filter the team’s recordings library by title, guest or participant name and email, company, host, status, tag, talking point, contact, date range, or a phrase said in the recording.
recording_transcriptRead one recording’s transcript line by line - who said what and when - a page at a time, continuing from the returned next_offset.

conversation_keyword_match

Find which saved contacts, or which external company email domains, were on the recorded calls where certain phrases were said - or not said - across the recordings the user can see.

Which people or companies said X across our calls: resolve an Include-ANY / Include-ALL / Exclude phrase filter over the team’s recording transcripts, narrowed to recordings visible to the caller, into the saved contacts who attended them (SavedPerson oids) or their external attendee email domains.

EndpointPOST https://api.prospeo.io/api/v2/tools/conversation-keyword-match
MCP toolconversation_keyword_match on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
matchstring (enum)Yespeople returns the saved contacts who attended the matching recordings; companies returns the external email domains of their attendees. One of: people, companies.
include_anyarray of stringNoMatch recordings whose transcript contains ANY of these phrases (each up to 100 characters), up to 25 phrases. Up to 25 items.
include_allarray of stringNoMatch recordings whose transcript contains ALL of these phrases (each up to 100 characters), up to 25 phrases. Up to 25 items.
excludearray of stringNoExclude recordings whose transcript contains any of these phrases (each up to 100 characters), up to 25 phrases. Up to 25 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

recording_ask

Ask a question about what was said in one recording’s meeting, such as ‘what did they say about pricing’ or ‘did they mention a competitor’, answered from its transcript.

Ask a natural-language question about one recording’s meeting, answered ONLY from its diarized transcript, with client-held (never persisted) conversation history. Returns answered:false with a locked refusal line when the answer isn’t grounded in the meeting, so a genuine miss, a guard hit, and a rate-limit read identically.

EndpointPOST https://api.prospeo.io/api/v2/tools/recording-ask
MCP toolrecording_ask on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
recording_idstringYesThe recording’s oid, from a prior recording_search or recording_get result. Pattern ^[0-9a-fA-F]{24}$.
questionstringYesThe question to answer from this recording’s transcript, up to 500 characters. Length 1 to 500.
historyarray of objectNoPrior turns of this same conversation, oldest first, up to 12; never persisted server-side. Up to 12 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

recording_create_followup_tasks

Create reviewed tasks from a recording’s follow-up suggestions.

Create the reviewed ‘suggested tasks’ rows (drawn from a recording’s AI next steps, or custom rows) as real Task objects (Source=AI_RECORDING), each linked back to the recording. Idempotent per next-step: a row already promoted to a Task on a prior submit is silently skipped, not duplicated.

EndpointPOST https://api.prospeo.io/api/v2/tools/recording-create-followup-tasks
MCP toolrecording_create_followup_tasks on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
recording_idstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
tasksarray of objectYesUp to 50 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

recording_draft_followup

Create a follow-up email prefill from one recording; this sends nothing.

Draft an AI-composed follow-up email for a recording: From the host’s connected mailbox, To the primary external participant, Subject ‘Recap and next steps - {meeting name}’, Body an AI recap that never includes a recording link. Returns a composer PREFILL only — creates and sends NOTHING; the human presses Send in the compose window.

EndpointPOST https://api.prospeo.io/api/v2/tools/recording-draft-followup
MCP toolrecording_draft_followup on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
recording_idstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

recording_get

Open one recording: who hosted and attended, when and how long, its AI outcome, next steps, objections, questions and decisions, talking-point hits, notes and who has access.

Load one recording’s single-recording view: the list-row facts (title, status, host, times, duration, participants, artifact flags) plus the detail-only blocks — attendee roster with CRM contact links, host notes, AI insights (outcome, next steps, objections, pain points, questions, topics, decisions), talking-point hits and the People-with-access list.

EndpointPOST https://api.prospeo.io/api/v2/tools/recording-get
MCP toolrecording_get on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
recording_idstringYesThe recording’s oid, from a prior recording_search result. Pattern ^[0-9a-fA-F]{24}$.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Search or filter the team’s recordings library by title, guest or participant name and email, company, host, status, tag, talking point, contact, date range, or a phrase said in the recording.

Search and filter the team’s recordings library: merged free-text search (meeting titles, guest/participant names+emails, company names, and spoken words — with a highlighted transcript snippet on a speech hit), plus host/status/source/tag/talking-point/participant/date-range/keyword-phrase-group facets, all AND-composed and visibility-scoped. Use whenever the user names any criterion; use recording_list for a bare browse.

EndpointPOST https://api.prospeo.io/api/v2/tools/recording-search
MCP toolrecording_search on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationPage-based: page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
pageintegerNoPage number, starting at 1, 25 recordings per page. From 1 to 100000. Default 1.
searchstringNoFree text over meeting titles, guest/participant names and emails, company names, and spoken words, up to 200 characters. Length 0 to 200.
recording_oidsarray of stringNoResolve a known set of recording oids in one page, bypassing pagination, up to 200. Up to 200 items.
host_idsarray of stringNoRestrict to recordings hosted by these teammates, by user oid, up to 100. Up to 100 items.
statusesarray of string (enum)NoStored recording-status values to include (the full 11-value set, not the collapsed display tag); empty means no status filter. Up to 11 items. Items one of: SCHEDULED, JOINING, IN_LOBBY, RECORDING, PROCESSING, ANALYZING, COMPLETED, SKIPPED, NOT_ADMITTED, CANCELED, FAILED.
sourcesarray of string (enum)NoRecording origin to include: PROSPEO or GONG; empty means no source filter. Up to 2 items. Items one of: PROSPEO, GONG.
tag_idsarray of stringNoRestrict to recordings carrying any of these tag oids, up to 100. Up to 100 items.
talking_point_idsarray of stringNoRestrict to recordings that hit any of these talking-point oids, up to 100. Up to 100 items.
contact_idsarray of stringNoRestrict to recordings a saved contact participated in, by SavedPerson oid, up to 100. Up to 100 items.
date_fromstringNoOnly include recordings at or after this UTC timestamp (ISO 8601; the recording’s effective date).
date_tostringNoOnly include recordings at or before this UTC timestamp (ISO 8601).
keyword_include_anyarray of stringNoMatch a recording whose transcript contains ANY of these phrases (each up to 100 characters), up to 25 phrases. Up to 25 items.
keyword_include_allarray of stringNoMatch a recording whose transcript contains ALL of these phrases (each up to 100 characters), up to 25 phrases. Up to 25 items.
keyword_excludearray of stringNoExclude recordings whose transcript contains any of these phrases (each up to 100 characters), up to 25 phrases. Up to 25 items.
sort_directionstring (enum)NoSort direction ASC or DESC over the recording’s effective date; omitted keeps newest-first. One of: ASC, DESC.
include_facetsbooleanNoWhether to also compute and return facet counts for this search; adds cost, so defaults to false for a tool call. Default false.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

recording_transcript

Read one recording’s transcript line by line - who said what and when - a page at a time, continuing from the returned next_offset.

Read one recording’s diarized transcript — structured lines with start offset, speaker and text, never bytes — a bounded page at a time from a line offset, with next_offset to continue. Empty when no READY transcript exists yet.

EndpointPOST https://api.prospeo.io/api/v2/tools/recording-transcript
MCP toolrecording_transcript on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationOffset-based: offset.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
recording_idstringYesThe recording’s oid, from a prior recording_search or recording_get result. Pattern ^[0-9a-fA-F]{24}$.
offsetintegerNoZero-based index of the first transcript line to return; pass the previous result’s next_offset to continue reading. From 0 to 100000. Default 0.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Last updated on