Documentation
API
- Polyglot API
- Authentication
Core Libraries
- Listener
- CLI
Plugins
SDKs
- React
- Javascript
- Vue.js
- Angular
- Reference
Polyglot API
choose your language
Our API SDK is available in multiple languages, making it easy to integrate Flatfile regardless of your tech stack. Each library gives you the full power of our platform in patterns you’ll feel right at home with.
Node
A JavaScript client for Flatfile.
Go
A Go client for Flatfile.
Python
A Python client for Flatfile.
Java
A Java client for Flatfile.
Coming Soon.
Setup
After installing the package, import the FlatfileClient and instantiate it by
passing in your secret key as the token.
import { FlatfileClient } from "@flatfile/api";
const token = "sk_your_secret_key";
const api = new FlatfileClient({ token });
Make sure to keep your secret key safe, as it can be used to access potentially sensitive information.
Making API Calls
Make API calls by calling the appropriate method on the api object.
Note
that responses are promises, so you’ll need to handle them accordingly.
Core API Methods
await api.actions.create({
spaceId: "us_sp_your_space_id",
workbookId: "us_wb_your_workbook_id",
actionConfig: { ... },
})
< API Reference />
await api.actions.get({
actionId: "us_ac_your_action_id"
})
< API Reference />
await api.actions.list({
spaceId: "us_sp_your_space_id",
workbookId: "us_wb_your_workbook_id",
filter: { ... },
page: 1,
pageSize: 10
})
< API Reference />
await api.actions.cancel({
actionId: "us_ac_your_action_id"
})
< API Reference />
await api.actions.retry({
actionId: "us_ac_your_action_id"
})
< API Reference />
await api.agents.create({
environmentId: "us_env_your_environment_id",
config: { ... }
})
< API Reference />
await api.agents.get({
agentId: "us_ag_your_agent_id"
})
< API Reference />
await api.agents.update({
agentId: "us_ag_your_agent_id",
config: { ... }
})
< API Reference />
await api.agents.delete({
agentId: "us_ag_your_agent_id"
})
< API Reference />
await api.agents.list({
environmentId: "us_env_your_environment_id",
filter: { ... }
})
< API Reference />
await api.agents.deploy({
agentId: "us_ag_your_agent_id"
})
< API Reference />
await api.agents.logs({
agentId: "us_ag_your_agent_id",
filter: { ... }
})
< API Reference />
await api.documents.create({
spaceId: "us_sp_your_space_id",
content: { ... }
})
< API Reference />
await api.documents.get({
documentId: "us_doc_your_document_id"
})
< API Reference />
await api.documents.update({
documentId: "us_doc_your_document_id",
content: { ... }
})
< API Reference />
await api.documents.delete({
documentId: "us_doc_your_document_id"
})
< API Reference />
await api.documents.list({
spaceId: "us_sp_your_space_id",
filter: { ... }
})
< API Reference />
await api.documents.share({
documentId: "us_doc_your_document_id",
recipients: ["user@example.com"]
})
< API Reference />
await api.environments.create({
name: "Production",
config: { ... }
})
< API Reference />
await api.environments.get({
environmentId: "us_env_your_environment_id"
})
< API Reference />
await api.environments.update({
environmentId: "us_env_your_environment_id",
config: { ... }
})
< API Reference />
await api.environments.delete({
environmentId: "us_env_your_environment_id"
})
< API Reference />
await api.environments.list()
< API Reference />
await api.environments.getSecrets({
environmentId: "us_env_your_environment_id"
})
< API Reference />
await api.environments.updateSecrets({
environmentId: "us_env_your_environment_id",
secrets: { ... }
})
< API Reference />
await api.files.upload({
data: fileData,
config: { ... }
})
< API Reference />
await api.files.download({
fileId: "us_fl_your_file_id"
})
< API Reference />
await api.files.get({
fileId: "us_fl_your_file_id"
})
< API Reference />
await api.files.delete({
fileId: "us_fl_your_file_id"
})
< API Reference />
await api.files.list({
filter: { ... }
})
< API Reference />
await api.files.validate({
fileId: "us_fl_your_file_id"
})
< API Reference />
await api.jobs.create({
config: { ... }
})
< API Reference />
await api.jobs.get({
jobId: "us_job_your_job_id"
})
< API Reference />
await api.jobs.update({
jobId: "us_job_your_job_id",
status: "completed"
})
< API Reference />
await api.jobs.cancel({
jobId: "us_job_your_job_id"
})
< API Reference />
await api.jobs.list({
filter: { ... }
})
< API Reference />
await api.jobs.logs({
jobId: "us_job_your_job_id"
})
< API Reference />
await api.records.create({
sheetId: "us_sh_your_sheet_id",
records: [ ... ]
})
< API Reference />
await api.records.get({
recordId: "us_rec_your_record_id"
})
< API Reference />
await api.records.update({
recordId: "us_rec_your_record_id",
data: { ... }
})
< API Reference />
await api.records.delete({
recordId: "us_rec_your_record_id"
})
< API Reference />
await api.records.list({
sheetId: "us_sh_your_sheet_id",
filter: { ... }
})
< API Reference />
await api.records.search({
sheetId: "us_sh_your_sheet_id",
query: "search term"
})
< API Reference />
await api.records.validate({
records: [ ... ]
})
< API Reference />
await api.records.bulk.create({
sheetId: "us_sh_your_sheet_id",
records: [ ... ]
})
< API Reference />
await api.records.bulk.update({
sheetId: "us_sh_your_sheet_id",
records: [ ... ]
})
< API Reference />
await api.records.bulk.delete({
sheetId: "us_sh_your_sheet_id",
recordIds: ["us_rec_id1", "us_rec_id2"]
})
< API Reference />
await api.sheets.create({
workbookId: "us_wb_your_workbook_id",
config: { ... }
})
< API Reference />
await api.sheets.get({
sheetId: "us_sh_your_sheet_id"
})
< API Reference />
await api.sheets.update({
sheetId: "us_sh_your_sheet_id",
config: { ... }
})
< API Reference />
await api.sheets.delete({
sheetId: "us_sh_your_sheet_id"
})
< API Reference />
await api.sheets.list({
workbookId: "us_wb_your_workbook_id"
})
< API Reference />
await api.sheets.configure({
sheetId: "us_sh_your_sheet_id",
config: { ... }
})
< API Reference />
await api.sheets.getSchema({
sheetId: "us_sh_your_sheet_id"
})
< API Reference />
await api.sheets.updateSchema({
sheetId: "us_sh_your_sheet_id",
schema: { ... }
})
< API Reference />
await api.sheets.commit({
sheetId: "us_sh_your_sheet_id"
})
< API Reference />
await api.spaces.create({
config: { ... }
})
< API Reference />
await api.spaces.get({
spaceId: "us_sp_your_space_id"
})
< API Reference />
await api.spaces.update({
spaceId: "us_sp_your_space_id",
config: { ... }
})
< API Reference />
await api.spaces.delete({
spaceId: "us_sp_your_space_id"
})
< API Reference />
await api.spaces.list()
< API Reference />
await api.spaces.getMetadata({
spaceId: "us_sp_your_space_id"
})
< API Reference />
await api.spaces.updateMetadata({
spaceId: "us_sp_your_space_id",
metadata: { ... }
})
< API Reference />
await api.spaces.getMembers({
spaceId: "us_sp_your_space_id"
})
< API Reference />
await api.spaces.addMember({
spaceId: "us_sp_your_space_id",
userId: "us_usr_your_user_id",
role: "admin"
})
< API Reference />
await api.spaces.removeMember({
spaceId: "us_sp_your_space_id",
userId: "us_usr_your_user_id"
})
< API Reference />
await api.users.get({
userId: "us_usr_your_user_id"
})
< API Reference />
await api.users.update({
userId: "us_usr_your_user_id",
data: { ... }
})
< API Reference />
await api.users.delete({
userId: "us_usr_your_user_id"
})
< API Reference />
await api.users.list({
filter: { ... }
})
< API Reference />
await api.users.invite({
email: "user@example.com",
role: "member"
})
< API Reference />
await api.users.getApiKeys({
userId: "us_usr_your_user_id"
})
< API Reference />
await api.users.createApiKey({
userId: "us_usr_your_user_id",
config: { ... }
})
< API Reference />
await api.users.revokeApiKey({
keyId: "us_key_your_key_id"
})
< API Reference />
await api.workbooks.create({
spaceId: "us_sp_your_space_id",
config: { ... }
})
< API Reference />
await api.workbooks.get({
workbookId: "us_wb_your_workbook_id"
})
< API Reference />
await api.workbooks.update({
workbookId: "us_wb_your_workbook_id",
config: { ... }
})
< API Reference />
await api.workbooks.delete({
workbookId: "us_wb_your_workbook_id"
})
< API Reference />
await api.workbooks.list({
spaceId: "us_sp_your_space_id"
})
< API Reference />
await api.workbooks.configure({
workbookId: "us_wb_your_workbook_id",
config: { ... }
})
< API Reference />
await api.workbooks.getSchema({
workbookId: "us_wb_your_workbook_id"
})
< API Reference />
await api.workbooks.updateSchema({
workbookId: "us_wb_your_workbook_id",
schema: { ... }
})
< API Reference />
await api.workbooks.commit({
workbookId: "us_wb_your_workbook_id"
})
< API Reference />