{"openapi":"3.1.0","info":{"title":"Claap (BYOK) API","version":"0.1.0","description":"Claap (BYOK) lets an AI assistant read your own Claap data through the Claap API with a key you supply (workspace API key). Read-only: 12 tools (get_workspace, list_recordings, get_recording, get_recording_transcript, list_recording_views, list_deals, get_deal, list_deal_stages, list_companies, list_contacts, list_users, list_user_groups). The BYOK key travels with each request, is used for that...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-claap.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-claap/docs"},"termsOfService":"https://connectorbay.com/byok-claap/terms"},"servers":[{"url":"https://byok-claap.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-claap/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_workspace":{"post":{"operationId":"get_workspace","summary":"Show the Claap workspace the key belongs to: name, creation date, member count and recording count. Claap allows 3 calls","description":"Show the Claap workspace the key belongs to: name, creation date, member count and recording count. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"Which Claap workspace is my key for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_workspaceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_recordings":{"post":{"operationId":"list_recordings","summary":"List Claap recordings, newest first by default, with title, date, duration, source, recorder, meeting participants, labe","description":"List Claap recordings, newest first by default, with title, date, duration, source, recorder, meeting participants, labels and links. Filter by date, folder, recorder, labels or source; page with the cursor. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"What customer calls did Claap record this week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"created_after":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only recordings created after this ISO 8601 time, for example 2026-10-01T00:00:00Z.","title":"Created After"},"created_before":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only recordings created before this ISO 8601 time.","title":"Created Before"},"channel_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only recordings in this folder (channel) ID.","title":"Channel Id"},"recorder_email":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only recordings made by this email address.","title":"Recorder Email"},"labels":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated label names; recordings with any of them.","title":"Labels"},"sources":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated sources, for example 'Zoom,GoogleMeet,MsTeams'.","title":"Sources"},"sort":{"anyOf":[{"enum":["created_asc","created_desc","duration_asc","duration_desc","title_asc","title_desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of results.","title":"Sort"},"view_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Use the filters and sorting of this recording view (ID from list_recording_views).","title":"View Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many recordings to return (1 to 100); keep it at 25 or less because answers are large.","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: result.pagination.nextCursor from the previous answer. Leave out for the first page.","title":"Cursor"}},"title":"list_recordingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_recording":{"post":{"operationId":"get_recording","summary":"Get one Claap recording with title, participants, links and, when available, AI key takeaways, outlines, action items, a","description":"Get one Claap recording with title, participants, links and, when available, AI key takeaways, outlines, action items, analytics, deal and companies. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"Summarize the Claap recording rec_abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"recording_id":{"description":"Recording ID as returned by list_recordings (id).","maxLength":100,"title":"Recording Id","type":"string"}},"required":["recording_id"],"title":"get_recordingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_recording_transcript":{"post":{"operationId":"get_recording_transcript","summary":"Get the transcript of a Claap recording as segments with speaker, text and times, or as plain text. Long transcripts are","description":"Get the transcript of a Claap recording as segments with speaker, text and times, or as plain text. Long transcripts are cut off. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"What was said in the Claap recording rec_abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"recording_id":{"description":"Recording ID as returned by list_recordings (id).","maxLength":100,"title":"Recording Id","type":"string"},"format":{"anyOf":[{"enum":["json","text"],"type":"string"},{"type":"null"}],"default":"json","description":"json for segments with speaker and times, or text for plain readable text.","title":"Format"},"lang":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter language code to get a translation; the original transcript when left out.","title":"Lang"}},"required":["recording_id"],"title":"get_recording_transcriptArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_recording_views":{"post":{"operationId":"list_recording_views","summary":"List the saved recording views of the workspace (public ones plus built-in defaults) with name, visibility and filters. ","description":"List the saved recording views of the workspace (public ones plus built-in defaults) with name, visibility and filters. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"What recording views are set up in Claap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_recording_viewsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_deals":{"post":{"operationId":"list_deals","summary":"List Claap deals synced from your CRM, most recently opened first, with title, status, amount, owner, stage and links. C","description":"List Claap deals synced from your CRM, most recently opened first, with title, status, amount, owner, stage and links. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"Which open deals does Claap have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"view_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Use the filters of this deal view (ID from the deal views).","title":"View Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100). Large answers are cut off, so keep it at 25 or less for recordings.","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: result.pagination.nextCursor from the previous answer. Leave out for the first page.","title":"Cursor"}},"title":"list_dealsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_deal":{"post":{"operationId":"get_deal","summary":"Get one Claap deal: title, status, amount, owner, pipeline, stage, companies, contacts and summary; optionally the AI fi","description":"Get one Claap deal: title, status, amount, owner, pipeline, stage, companies, contacts and summary; optionally the AI field values. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"Show Claap deal d1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deal_id":{"description":"Deal ID as returned by list_deals (dealId).","maxLength":100,"title":"Deal Id","type":"string"},"return_ai_fields":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include the AI field values of the deal.","title":"Return Ai Fields"}},"required":["deal_id"],"title":"get_dealArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_deal_stages":{"post":{"operationId":"list_deal_stages","summary":"List the deal stages of the CRM connected to Claap (HubSpot only) with the pipeline each belongs to. Claap allows 3 call","description":"List the deal stages of the CRM connected to Claap (HubSpot only) with the pipeline each belongs to. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"What deal stages exist in Claap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_deal_stagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_companies":{"post":{"operationId":"list_companies","summary":"List companies known to Claap, newest first by default, with domains, linked deals and contacts and last interaction. Cl","description":"List companies known to Claap, newest first by default, with domains, linked deals and contacts and last interaction. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"Which companies has Claap seen lately\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sort":{"anyOf":[{"enum":["created_asc","created_desc","last_interaction_asc","last_interaction_desc","name_asc","name_desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of results.","title":"Sort"},"view_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Use the filters of this company view.","title":"View Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100). Large answers are cut off, so keep it at 25 or less for recordings.","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: result.pagination.nextCursor from the previous answer. Leave out for the first page.","title":"Cursor"}},"title":"list_companiesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_contacts":{"post":{"operationId":"list_contacts","summary":"List contacts known to Claap, by name, with email, company, external flag and summary. Claap allows 3 calls per second a","description":"List contacts known to Claap, by name, with email, company, external flag and summary. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"Who are our contacts at Acme in Claap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sort":{"anyOf":[{"enum":["email_asc","email_desc","last_interaction_asc","last_interaction_desc","name_asc","name_desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order of results.","title":"Sort"},"view_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Use the filters of this contact view.","title":"View Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100). Large answers are cut off, so keep it at 25 or less for recordings.","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: result.pagination.nextCursor from the previous answer. Leave out for the first page.","title":"Cursor"}},"title":"list_contactsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_users":{"post":{"operationId":"list_users","summary":"List the users of the Claap workspace with name, email, role, license and state. Claap allows 3 calls per second and 3,0","description":"List the users of the Claap workspace with name, email, role, license and state. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"Who is in our Claap workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"email":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the user with this exact email.","title":"Email"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100). Large answers are cut off, so keep it at 25 or less for recordings.","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: result.pagination.nextCursor from the previous answer. Leave out for the first page.","title":"Cursor"}},"title":"list_usersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_user_groups":{"post":{"operationId":"list_user_groups","summary":"List the user groups of the Claap workspace with their member IDs. Claap allows 3 calls per second and 3,000 calls per d","description":"List the user groups of the Claap workspace with their member IDs. Claap allows 3 calls per second and 3,000 calls per day per workspace. Use for \"What user groups exist in Claap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100). Large answers are cut off, so keep it at 25 or less for recordings.","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: result.pagination.nextCursor from the previous answer. Leave out for the first page.","title":"Cursor"}},"title":"list_user_groupsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}