Polyglot API
choose your language
Legacy Documentation - This documentation is maintained for backward compatibility. For the latest API documentation, please visit our current API reference.
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.
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
actions.create
actions.create
actions.get
actions.get
actions.list
actions.list
actions.cancel
actions.cancel
actions.retry
actions.retry
agents.create
agents.create
agents.get
agents.get
agents.update
agents.update
agents.delete
agents.delete
agents.list
agents.list
agents.deploy
agents.deploy
agents.logs
agents.logs
documents.create
documents.create
documents.get
documents.get
documents.update
documents.update
documents.delete
documents.delete
documents.list
documents.list
documents.share
documents.share
environments.create
environments.create
environments.get
environments.get
environments.update
environments.update
environments.delete
environments.delete
environments.list
environments.list
environments.getSecrets
environments.getSecrets
environments.updateSecrets
environments.updateSecrets
files.upload
files.upload
files.download
files.download
files.get
files.get
files.delete
files.delete
files.list
files.list
files.validate
files.validate
jobs.create
jobs.create
jobs.get
jobs.get
jobs.update
jobs.update
jobs.cancel
jobs.cancel
jobs.list
jobs.list
jobs.logs
jobs.logs
records.create
records.create
records.get
records.get
records.update
records.update
records.delete
records.delete
records.list
records.list
records.search
records.search
records.validate
records.validate
records.bulk.create
records.bulk.create
records.bulk.update
records.bulk.update
records.bulk.delete
records.bulk.delete
sheets.create
sheets.create
sheets.get
sheets.get
sheets.update
sheets.update
sheets.delete
sheets.delete
sheets.list
sheets.list
sheets.configure
sheets.configure
sheets.getSchema
sheets.getSchema
sheets.updateSchema
sheets.updateSchema
sheets.commit
sheets.commit
spaces.create
spaces.create
spaces.get
spaces.get
spaces.update
spaces.update
spaces.delete
spaces.delete
spaces.list
spaces.list
spaces.getMetadata
spaces.getMetadata
spaces.updateMetadata
spaces.updateMetadata
spaces.getMembers
spaces.getMembers
spaces.addMember
spaces.addMember
spaces.removeMember
spaces.removeMember
users.get
users.get
users.update
users.update
users.delete
users.delete
users.list
users.list
users.invite
users.invite
users.getApiKeys
users.getApiKeys
users.createApiKey
users.createApiKey
users.revokeApiKey
users.revokeApiKey
workbooks.create
workbooks.create
workbooks.get
workbooks.get
workbooks.update
workbooks.update
workbooks.delete
workbooks.delete
workbooks.list
workbooks.list
workbooks.configure
workbooks.configure
workbooks.getSchema
workbooks.getSchema
workbooks.updateSchema
workbooks.updateSchema
workbooks.commit
workbooks.commit