kintone attachment datasource

kintone_file_datasource

Author: r3-yamauchi
Version: 0.0.3
Type: datasource

English | Japanese

The source code of this plugin is available in the GitHub repository.

Description

This datasource plugin exposes kintone attachments as an Online Drive datasource for Dify. The plugin queries kintone records, enumerates attachment-type fields, and surfaces each file as a downloadable asset inside Dify.

Prerequisites

1. Generate an API token for the target kintone app with view permission (including attachment download).
2. Import the plugin into Dify and configure the provider credentials. All operational values (app ID, attachment fields, query, record limits, etc.) live at the provider level.
3. Each datasource instance only exposes the debug_logging flag; all other inputs come from the provider configuration.

Provider Parameters

Parameter	Required	Description
kintone_base_url	✅	Domain of the kintone environment (e.g. https://example.cybozu.com).
kintone_api_token	✅	1–9 API tokens separated by commas.
app_id	✅	Numeric kintone App ID to expose.
attachment_field_codes	✅	Comma-separated attachment field codes to scan (e.g. Attachment_A,Attachment_B).
query	❌	Optional kintone query string.

Datasource Parameter

Parameter	Description
debug_logging	When true, emits masked debug logs containing query info, record counts, and attachment field lists.

Configuration Example

# Provider credentials
kintone_base_url: https://example.cybozu.com
kintone_api_token: BuBNIwbRRaUvr33nWXcfUZ5VhaFsJxN0xH4NPN92, YuLjjdiOECJjV5ZDbFwh5BZoJJGDx3LtdCE1Dl7E
app_id: "999"
attachment_field_codes: Attachment_A,Attachment_B
query: ""

# Datasource parameter
debug_logging: true

Browse Workflow (_browse_files)

1. Validate and normalize attachment_field_codes; reject empty input.
2. Resolve app_id, query, and pagination cursors from the request/environment.
3. Fetch records from kintone, enumerate attachment fields, and emit OnlineDriveFile entries with composite IDs <record_id>:<file_key>.
4. Return OnlineDriveBrowseFilesResponse with is_truncated and next_page_parameters set when more data remains (supports attachment-level cursoring).

Download Workflow (_download_file)

1. Split the requested file ID into record_id and file_key.
2. Fetch the record via get_record and locate the attachment within the allowed field codes.
3. Download the binary through k/v1/file.json and emit a blob message with metadata (file_name, mime_type, size, plus kintone identifiers such as record_id, app_id, field_code, bucket_id). Downstream nodes treat it exactly like the Google Drive datasource output.

Privacy Policy

This plugin only collects the following necessary information for interacting with kintone:

1. kintone domain, app ID, and API token with appropriate permissions
2. User-provided query parameters for filtering records and selecting fields

This information is used solely for retrieving records and downloading attached files from the specified kintone app and will not be used for other purposes or shared with third parties.

Data retrieval uses kintone's official REST API endpoints:

• https://{kintone-domain}/k/v1/records.json (record listing)
• https://{kintone-domain}/k/v1/record.json (single record retrieval)
• https://{kintone-domain}/k/v1/file.json (file download)

For related privacy policies, please refer to: cybozu.com Terms of Use.

Data Storage

• The plugin does not store data locally
• Retrieved file content is transmitted to Dify knowledge base and stored according to Dify's data retention policies
• API URI is managed by Dify's plugin system. API secrets should be injected at runtime through Dify workflows or environment secrets so they are not persisted with the provider configuration.

Security

• API communications are encrypted via HTTPS
• API secrets are not stored by the provider; inject them via secure workflow variables or environment secrets at execution time.

Third-Party Disclosure

This plugin does not send data to any third parties other than the Dify API endpoint specified by the user.

License

This project is released under the MIT License.

"kintone" is a registered trademark of Cybozu, Inc.

The information provided here is for reference only. Support is not available for individual environments. We are unable to respond to inquiries about configuration details or cases where the plugin does not work in your environment.