Introduction

Get started with our fileAI API

Our fileAI API is organized around REST and uses standard HTTP methods (POST, GET, PATCH) to interact with resource objects. It uses JSON as the primary data format, and all requests should have a Content-Type of application/json.


How to get started?

Before using our API, please ensure you complete the following prerequisites:

  • You must have a fileAI account - Sign up or login here
  • You must have an API Key - After creating your fileAI account, you can generate your API Key. Refer to the Authentication section for more details.
  • You must verify an AI Schema if you want to receive deterministic responses. Our system automatically suggests extraction and data fetch schemas. In our UI, confirm or edit the schema to call it directly.

What’s Next