v4

latestSwagger 2.02026-08-0343714211.7 MB

ai_tasks

Ai Tasks

List Ai Tasks

get/ai_tasks

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, id, disabled or updated_at.

If set, return records where the specified field is equal to the supplied value. Valid fields are disabled, trigger or workspace_id. Valid field combinations are [ workspace_id, disabled ].

Response

A list of AiTasks objects.

idinteger

AI Task ID.

workspace_idinteger

Workspace ID. 0 means the default workspace.

namestring

AI Task name.

descriptionstring

AI Task description.

promptstring

Prompt sent when this AI Task is invoked.

permission_set'full' | 'files_only'

Permissions used by the internal API key for this AI Task. Valid values are full and files_only.

pathstring

Path scope used for action-triggered AI Tasks.

sourcestring

Source glob used with path for action-triggered AI Tasks.

disabledboolean

If true, this AI Task will not run.

trigger'manual' | 'daily' | 'custom_schedule' | 'action'

How this AI Task is triggered.

trigger_actionsstring[]

If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.

intervalstring

If trigger is daily, this specifies how often to run the AI Task.

recurring_dayinteger

If trigger is daily, this selects the day number inside the chosen interval.

schedule_days_of_weekinteger[]

If trigger is custom_schedule, the 0-based weekdays used by the schedule.

schedule_times_of_daystring[]

Times of day in HH:MM format for scheduled AI Tasks.

schedule_time_zonestring

Time zone used by the AI Task schedule.

holiday_regionstring

Optional holiday region used by scheduled AI Tasks.

human_readable_schedulestring

Human-readable schedule description.

last_run_atstring date-time

Most recent successful invocation time.

master_admin_user_idinteger

Master User ID used for AI Task invocations.

created_atstring date-time

Creation time.

updated_atstring date-time

Last update time.

Example response

[
  {
    "id": 1,
    "name": "Summarize daily reports",
    "description": "Summarizes files uploaded by the accounting team.",
    "prompt": "Summarize the uploaded file and identify follow-up actions.",
    "permission_set": "files_only",
    "path": "incoming/reports",
    "source": "*.pdf",
    "disabled": true,
    "trigger": "daily",
    "trigger_actions": [
      "create"
    ],
    "interval": "day",
    "recurring_day": 1,
    "schedule_days_of_week": [
      1,
      3,
      5
    ],
    "schedule_times_of_day": [
      "06:30"
    ],
    "schedule_time_zone": "Eastern Time (US & Canada)",
    "holiday_region": "us",
    "human_readable_schedule": "Runs every day at 06:30 AM UTC TZ.",
    "last_run_at": "2000-01-01T01:00:00Z",
    "master_admin_user_id": 1,
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]