koncile-js/README.md

JavaScript SDK for the Koncile Intelligent Document Processing API

# Koncile JavaScript SDK

The official JavaScript/TypeScript SDK for [Koncile](https://koncile.ai), providing a seamless interface to interact with the Koncile Intelligent Document Processing API.

## Features

- Authentication via API key
- File operations (upload, download, manage)
- Task management and result tracking
- Folder organization and deletion
- Template creation and retrieval
- Field creation and configuration
- Instruction handling
- Document management
- Full TypeScript support with types included

## Installation

Install the SDK via npm:

```bash
npm install koncile-js
```

## Quick Start
```bash
const { Koncile } = require('koncile-js');

#  Initialize the SDK
const sdk = new Koncile('your-api-key');

#  Example: Create a folder
(async () => {
  try {
    const folderResponse = await sdk.folders.create(
      'Invoices',
      'Folder for 2025 invoices'
    );
    console.log('Folder created:', folderResponse.data);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
})();

```
You can also load the API key from a .env file:

```bash
API_KEY=your-api-key

require('dotenv').config();
const sdk = new Koncile(process.env.API_KEY);

```
## Documentation
For detailed API documentation and guides, visit docs.koncile.ai.

## Support

For direct help, contact us at support@koncile.ai.

## License

This project is licensed under the MIT License — see the LICENSE file for details.

© 2025 Koncile. All rights reserved.