Filesystem Integration

The filesystem integration connects a shared directory to your workspace. Enable the filesystem connector first in the operator guide: Filesystem integration setup.

Basic request and response

Create a filesystem integration with POST /api/v1/app/integration/filesystem.

curl -X POST "https://{BASE_URL}/api/v1/app/integration/filesystem" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "{file_system_username}",
    "password": "{file_system_password}"
  }'

Example response

{
  "id": "fs_9f8e7d6c5b4a3c2d",
  "user_id": "user_4b7c2a1d9e5f3c8b",
  "org_id": "org_2f3a9d1c7b5e4a8f",
  "type": "FileSystem",
  "created_at": "2026-02-08T14:10:00Z",
  "updated_at": "2026-02-08T14:10:00Z"
}

Update integration credentials

Endpoint parameters

Type	Name	Required	Notes
Path	`integrationID`	Yes	Integration identifier.
Body	`username`	Yes	Filesystem username.
Body	`password`	Yes	Filesystem password.

curl -X POST "https://{BASE_URL}/api/v1/app/integration/filesystem/{integrationID}" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "{file_system_username}",
    "password": "{file_system_password}"
  }'

Example response

{
  "id": "fs_9f8e7d6c5b4a3c2d",
  "user_id": "user_4b7c2a1d9e5f3c8b",
  "org_id": "org_2f3a9d1c7b5e4a8f",
  "type": "FileSystem",
  "created_at": "2026-02-08T14:10:00Z",
  "updated_at": "2026-02-08T15:02:00Z"
}

Get integration config

curl "https://{BASE_URL}/api/v1/app/integration/filesystem/{integrationID}/config" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

Example response

{
  "path": "/mnt/shared/support"
}

Validate credentials

Endpoint parameters

Type	Name	Required	Notes
Query	`username`	Yes	Filesystem username to validate.
Query	`password`	Yes	Filesystem password to validate.

curl "https://{BASE_URL}/api/v1/app/integration/filesystem/validate?username={file_system_username}&password={file_system_password}" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

Example response

true

List files

Endpoint parameters

Type	Name	Required	Notes
Query	`integrationId`	Yes	Filesystem integration identifier.

curl "https://{BASE_URL}/api/v1/app/integration/filesystem/files?integrationId={integrationID}" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

Example response

[
  {
    "path": "/mnt/shared/support/weekly-brief.pdf",
    "name": "weekly-brief.pdf",
    "size": 287104,
    "updated_at": "2026-02-07T19:22:10Z"
  }
]

Start an ingest sync

curl -X POST "https://{BASE_URL}/api/v1/app/integration/filesystem/{integrationID}/ingest" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}" \
  -H "Content-Type: application/json"

Example response

{
  "type": "sync_started",
  "current_artifact_count": 12,
  "integration_item_count": 48
}

Errors and edge cases

403: connector not enabled or missing permissions.
400: invalid credentials.
404: integration ID not found.

​Basic request and response

​Update integration credentials

​Get integration config

​Validate credentials

​List files

​Start an ingest sync

​Errors and edge cases

Basic request and response

Update integration credentials

Get integration config

Validate credentials

List files

Start an ingest sync

Errors and edge cases