Registry / web-framework / fathom-typescript

fathom-typescript

JSON →
library0.0.37jsnpmunverified

The `fathom-typescript` package is Fathom's official TypeScript SDK, providing programmatic access to the Fathom External API. It allows developers to interact with Fathom meetings, teams, and team members, including operations like listing meetings, retrieving recording summaries and transcripts, and managing webhooks. The current stable version is 0.0.37. As an official SDK, it is actively maintained and designed to stay in sync with the Fathom API, though semantic versioning might not be strictly followed before a 1.0 release. It offers both CommonJS and ES Modules support, making it versatile for various JavaScript environments. Key differentiators include its direct integration with the Fathom platform and type-safe access to API resources, reducing common development errors through its comprehensive TypeScript definitions.

web-frameworkllm-agents
package ↗homepage ↗
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18–226 runs
build_error
glibc
node 18–226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

The primary SDK client class. Supports both CommonJS and ES Modules environments.

import { Fathom } from 'fathom-typescript';

Example of importing a specific type for an API operation's response for enhanced type safety. The exact path to specific types might vary based on SDK structure.

import type { ListMeetingsResponse } from 'fathom-typescript/dist/sdk/models/operations';

Example of importing an enum type used for request parameters, ensuring type-safe API calls. The exact path to shared types might vary.

import type { MeetingType } from 'fathom-typescript/dist/sdk/models/shared';

Initializes the Fathom SDK client with an API key and demonstrates how to list meetings, iterating through potentially paginated results securely.

import { Fathom } from "fathom-typescript"; const fathom = new Fathom({ security: { apiKeyAuth: process.env.FATHOM_API_KEY ?? 'YOUR_API_KEY_HERE', }, }); async function run() { try { const result = await fathom.listMeetings({ calendarInviteesDomains: [ "acme.com", "client.com" ], meetingType: "all", recordedBy: [ "ceo@acme.com", "pm@acme.com" ], teams: [ "Sales", "Engineering" ] }); if (result) { for await (const page of result) { console.log("Retrieved meetings for page:", page); } } else { console.log("No meetings found or an empty result was returned."); } } catch (error) { console.error("Error listing meetings:", error); } } run();
Debug
Known footguns
breakingAs a pre-1.0 release, minor versions (`0.x.0` to `0.y.0`) and even patch versions (`0.0.x` to `0.0.y`) of `fathom-typescript` may introduce breaking API changes without strictly adhering to semantic versioning.
gotchaHardcoding API keys directly in source code or committing them to version control (like in the quickstart example) is a significant security risk.
gotchaAPI operations that return multiple results (e.g., `listMeetings`) often implement pagination. Incorrectly handling pagination (e.g., forgetting to iterate or access subsequent pages) can lead to incomplete data retrieval.
Upgrade
Version history

Breaking-change detection hasn't run for this library yet.

Audit
Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity
51 hits · last 30 days
gptbot
4
ahrefsbot
4
script
1
bytedance
1
Resources
packagehttps://www.npmjs.com/package/fathom-typescript ↗
homepagehttps://fathom.video ↗