
Product
Introducing Socket MCP for Claude Desktop
Add secure dependency scanning to Claude Desktop with Socket MCP, a one-click extension that keeps your coding conversations safe from malicious packages.
@flatfile/api
Advanced tools
[](https://www.npmjs.com/package/@flatfile/api) [](https://buildwithfern.com/?utm_source=flatfilers/f
The Flatfile Node.js library provides convenient access to the Flatfile API from JavaScript/TypeScript.
API reference documentation is available here.
npm install --save @flatfile/api
# or
yarn add @flatfile/api
import { FlatfileClient } from '@flatfile/api';
async function main() {
const flatfile = new FlatfileClient({
// This is usually the environment specific "Secret Key" that can be found
// on the Getting Started page in the Flatfile dashboard.
token: 'YOUR_API_KEY',
});
const workbook = await flatfile.workbooks.create({
name: 'SDK Example',
sheets: [
{
name: 'Contacts',
slug: 'contacts',
fields: [
{
key: 'firstName',
type: 'string',
label: 'First Name',
},
{
key: 'lastName',
type: 'string',
label: 'Last Name',
},
{
key: 'email',
type: 'string',
label: 'Email',
},
],
actions: [
{
slug: 'submitAction',
label: 'Submit',
type: 'string',
description: 'Submit data to webhook.site',
primary: true,
},
],
},
],
});
console.log('Created workbook with id:', workbook.data.id);
}
When the API returns a non-success status code (4xx or 5xx response), a subclass of FlatfileError will be thrown:
try {
await client.agents.get("environment-id", "agent-id");
} catch (err) {
if (err instanceof FlatfileError) {
console.log(err.statusCode); // 400
console.log(err.message); // "BadRequestError"
console.log(err.body); // list of errors
}
}
Error codes are as followed:
Status Code | Error Type |
---|---|
400 | BadRequestError |
404 | NotFoundError |
The flatfile platform emits different events (e.g. user:added
, webhook:removed
). The SDK uses discriminated unions that make it easy to handle specific events.
const event = eventResponse.data;
if (event.type === 'job:ready') {
console.log(event.payload.operation); // FILE
console.log(event.payload.type); // PIPELINE
} else if (event.type === 'records:created') {
console.log(event.payload.count) // 100
}
The SDK uses discriminated unions that make it easy to introspect different fields.
for (const field of sheet.config.fields) {
if (field.type === 'boolean') {
console.log(field.config?.allowIndeterminate); // false
} else if (field.type === "number") {
console.log(field.config?.decimalPlaces); // 2
} else if (field.type === "enum") {
console.log(field.config.allowCustom); // true
}
}
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
This project is licensed under the MIT License - see the LICENSE file for details.
FAQs
[](https://www.npmjs.com/package/@flatfile/api) [](https://buildwithfern.com/?utm_source=flatfilers/f
The npm package @flatfile/api receives a total of 53,363 weekly downloads. As such, @flatfile/api popularity was classified as popular.
We found that @flatfile/api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Add secure dependency scanning to Claude Desktop with Socket MCP, a one-click extension that keeps your coding conversations safe from malicious packages.
Product
Socket now supports Scala and Kotlin, bringing AI-powered threat detection to JVM projects with easy manifest generation and fast, accurate scans.
Application Security
/Security News
Socket CEO Feross Aboukhadijeh and a16z partner Joel de la Garza discuss vibe coding, AI-driven software development, and how the rise of LLMs, despite their risks, still points toward a more secure and innovative future.