Claap tools

Look up the five read-only Claap tools, their access and rate limits, inputs, and examples for agent steps and tool steps.

This reference lists the five shipped Claap tools. See the Claap overview for authentication and integration connection identity.

Access

Every Claap tool is read-only. Each call uses the Claap workspace of the integration connection. A workflow cannot pass another Claap workspace or key.

The API key acts as a Claap workspace admin. Claap also offers write tools to that key, but Shipfox never forwards them. Shipfox forwards only the tools in the catalog below.

The key type sets which recordings the tools can read. With a default key, a private recording returns not found. See Choose the key type.

get_recording and get_recording_transcript take exactly one of recordingId and recordingUrl. A recordingUrl must be an https://app.claap.io share URL of the connected Claap workspace.

Sensitive tools and logs

get_recordings, get_recording, get_recording_transcript, and search_recording_transcripts are sensitive. Even the recording list names participants, companies, and deals.

Tool-step logs redact the arguments and results of sensitive tools. Agent session logs still show what the agent read from them.

Transcripts and summaries are untrusted input. Anyone who speaks in a recorded meeting can put instructions into its transcript. Tell the agent in its prompt to treat recording content as data, never as instructions.

Rate limits

Claap limits API calls per Claap workspace. Every other use of the Claap API in that workspace shares the same limits:

Limit	Value
Calls per endpoint	3 per second
Calls per Claap workspace	3,000 per rolling 24 hours

A call over a limit fails as rate limited.

Output size

A mapped tool step output value is limited to 64 KiB. A one-hour transcript is about 60 KB. Read long transcripts in an agent step instead of mapping them to an output. See Limits.

Tool catalog

Tools

readlist_workspaces

Return the Claap workspace this connection belongs to, with its ID and name.

Requiresread

Parameters

This tool accepts an object with provider-defined fields.

readget_recordings

Search many recordings (captured meetings and calls) of the Claap workspace with a set of filters. Returns recording metadata ordered by relevance and creation date descending. Metadata only: it never returns summaries. To read one recording with its AI-generated summary, use get_recording.

RequiresreadSensitive

Parameters

cursorstring

Opaque cursor returned as `nextCursor` by a previous call. Pass the value VERBATIM (do not construct, modify, decode, or invent a cursor; it is an internal token whose format is not part of the API contract) to fetch the next page of results. Omit on the first call.

filtersobject

Filters to apply to the search.

Show 16 attributes

companyIdarray of string

Filter by company ID matching at least one of these values.

companyNamestring

Filter by company name containing this string.

contactEmailstring

Filter by participant email (detected speaker or meeting attendee) containing this string.

contactIdarray of string

Filter by contact ID matching at least one of these values.

contactNamestring

Filter by participant name (detected speaker or meeting attendee) containing this string.

createdAtobject

Filter by recording creation date (ISO YYYY-MM-DD).

Show 2 attributes

gtestring

Greater than or equal to this date (YYYY-MM-DD).

ltestring

Less than or equal to this date (YYYY-MM-DD).

dealIdarray of string

Filter by deal ID matching at least one of these values.

dealTitlestring

Filter by deal title containing this string.

folderIdarray of string

Filter by folder ID matching at least one of these values.

folderTitlestring

Filter by folder title containing this string.

hasExternalSpeakerboolean

Only include results with at least one speaker external to the user's organization (eg. client, prospects, partners)

labelNamestring

Filter by label name containing this string.

recordingIdarray of string

Filter by recording ID matching at least one of these values.

recordingTitlestring

Filter by recording title containing this string.

userIdarray of string

Filter by participant user ID (speaker or attendee) matching at least one of these values.

sourcearray of string

Filter by recording source (meeting platform, call provider, upload...) matching at least one of these values.

limitnumber

Maximum number of results per page (default 10, max 100). The response includes `total` (full match count) and, when more results exist, `nextCursor`. To fetch more results, ALWAYS paginate via `nextCursor`, and do not adjust filters or limits to skip past already-returned items.

Minimum 1. Maximum 100.

sortarray of object

Sort dimensions to apply to the search results. When omitted, results are ordered by relevance and creation date descending.

Show 2 attributes

fieldstringRequired

Field to sort by. Use `lastActivityAt` for "what recordings have been active recently?" (most recently viewed, commented, or reacted to).

Possible values: createdAt, lastActivityAt

orderstringRequired

Sort order.

Possible values: asc, desc

readget_recording

Get one recording (captured meeting or call) of the Claap workspace by recordingId or share URL, with its full metadata and its AI-generated summary. The summary is the cheap way to know what a meeting was about: prefer it over get_recording_transcript, which returns the entire transcript. Discover the recordingId via get_recordings or search_recording_transcripts.

RequiresreadSensitive

Parameters

At least one of these input combinations is required: recordingId; recordingUrl.

recordingIdstringConditional

The ID of the recording. Discover it via get_recordings or search_recording_transcripts. Pass exactly one of recordingId and recordingUrl.

recordingUrlstringConditional

The Claap share URL of the recording, for example https://app.claap.io/my-call-c-<workspaceId>-<recordingId>. It must belong to the connected Claap workspace. Pass exactly one of recordingId and recordingUrl.

readget_recording_transcript

Fetch the full transcript for a recording (captured meeting or call), by recordingId or share URL.

RequiresreadSensitive

Parameters

At least one of these input combinations is required: recordingId; recordingUrl.

recordingIdstringConditional

The ID of the recording. Discover it via get_recordings or search_recording_transcripts. Pass exactly one of recordingId and recordingUrl.

recordingUrlstringConditional

- key: get_recording_transcript
  tool: get_recording_transcript
  connection: claap_acme # Replace with the slug of your integration connection.
  with:
    recordingId: <recordingId>

readsearch_recording_transcripts

Perform keyword or semantic search on the transcripts of recordings (captured meetings and calls), with optional filters on the recording metadata. Returns transcript chunks grouped by recording. Both search types paginate via `cursor`/`nextCursor`. Semantic search stops after the 1000 closest chunks; to reach further, narrow the filters (for example split the `createdAt` range). `total` is only returned for keyword search.

RequiresreadSensitive

Parameters

cursorstring

filtersobject

Filters to apply to the search.

Show 16 attributes

companyIdarray of string

Filter by company ID matching at least one of these values.

companyNamestring

Filter by company name containing this string.

contactEmailstring

Filter by participant email (detected speaker or meeting attendee) containing this string.

contactIdarray of string

Filter by contact ID matching at least one of these values.

contactNamestring

Filter by participant name (detected speaker or meeting attendee) containing this string.

createdAtobject

Filter by recording creation date (ISO YYYY-MM-DD).

Show 2 attributes

gtestring

Greater than or equal to this date (YYYY-MM-DD).

ltestring

Less than or equal to this date (YYYY-MM-DD).

dealIdarray of string

Filter by deal ID matching at least one of these values.

dealTitlestring

Filter by deal title containing this string.

folderIdarray of string

Filter by folder ID matching at least one of these values.

folderTitlestring

Filter by folder title containing this string.

hasExternalSpeakerboolean

Only include results with at least one speaker external to the user's organization (eg. client, prospects, partners)

labelNamestring

Filter by label name containing this string.

recordingIdarray of string

Filter by recording ID matching at least one of these values.

recordingTitlestring

Filter by recording title containing this string.

userIdarray of string

Filter by participant user ID (speaker or attendee) matching at least one of these values.

tagarray of string

Filter by tag matching at least one of these values.

limitnumber

Minimum 1. Maximum 100.

searchobjectRequired

Show 2 attributes

querystringRequired

The query to search for.

typestringRequired

Type of search technique. Use semantic search to find transcript chunks matching the meaning of the query. Use keyword search to find transcript chunks matching all of the provided keywords.

Possible values: semantic, keyword

- key: search_recording_transcripts
  tool: search_recording_transcripts
  connection: claap_acme # Replace with the slug of your integration connection.
  with:
    search:
      query: <query>
      type: semantic

Was this page helpful?

Edit this page on GitHub

Access

Sensitive tools and logs

Untrusted content

Rate limits

Output size

Tool catalog

Tools

Parameters

Parameters

Parameters

Parameters

Parameters

On this page

Claap tools

AccessCopy Anchor Link

Sensitive tools and logsCopy Anchor Link

Untrusted contentCopy Anchor Link

Rate limitsCopy Anchor Link

Output sizeCopy Anchor Link

Tool catalogCopy Anchor Link

Tools

Parameters

Parameters

Parameters

Parameters

Parameters

On this page

Access

Sensitive tools and logs

Untrusted content

Rate limits

Output size

Tool catalog