Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. AiTask
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.AiTask

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    An AI Task defines a Files.com AI prompt that can run on a schedule or in response to file actions.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleAiTask = new filescom.AiTask("example_ai_task", {
    description: "Summarizes files uploaded by the accounting team.",
    disabled: true,
    holidayRegion: "us",
    interval: "day",
    name: "Summarize daily reports",
    path: "incoming/reports",
    permissionSet: "files_only",
    prompt: "Summarize the uploaded file and identify follow-up actions.",
    recurringDay: 1,
    recurringDays: [
        1,
        15,
    ],
    scheduleId: 1,
    scheduleDaysOfWeeks: [
        1,
        3,
        5,
    ],
    scheduleTimeZone: "Eastern Time (US & Canada)",
    scheduleTimesOfDays: ["06:30"],
    source: "*.pdf",
    trigger: "daily",
    triggerActions: ["create"],
    workspaceId: 0,
});

    import pulumi
import pulumi_filescom as filescom

example_ai_task = filescom.AiTask("example_ai_task",
    description="Summarizes files uploaded by the accounting team.",
    disabled=True,
    holiday_region="us",
    interval="day",
    name="Summarize daily reports",
    path="incoming/reports",
    permission_set="files_only",
    prompt="Summarize the uploaded file and identify follow-up actions.",
    recurring_day=1,
    recurring_days=[
        1,
        15,
    ],
    schedule_id=1,
    schedule_days_of_weeks=[
        1,
        3,
        5,
    ],
    schedule_time_zone="Eastern Time (US & Canada)",
    schedule_times_of_days=["06:30"],
    source="*.pdf",
    trigger="daily",
    trigger_actions=["create"],
    workspace_id=0)

    package main

import (
	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filescom.NewAiTask(ctx, "example_ai_task", &filescom.AiTaskArgs{
			Description:   pulumi.String("Summarizes files uploaded by the accounting team."),
			Disabled:      pulumi.Bool(true),
			HolidayRegion: pulumi.String("us"),
			Interval:      pulumi.String("day"),
			Name:          pulumi.String("Summarize daily reports"),
			Path:          pulumi.String("incoming/reports"),
			PermissionSet: pulumi.String("files_only"),
			Prompt:        pulumi.String("Summarize the uploaded file and identify follow-up actions."),
			RecurringDay:  pulumi.Int(1),
			RecurringDays: pulumi.IntArray{
				pulumi.Int(1),
				pulumi.Int(15),
			},
			ScheduleId: pulumi.Int(1),
			ScheduleDaysOfWeeks: pulumi.IntArray{
				pulumi.Int(1),
				pulumi.Int(3),
				pulumi.Int(5),
			},
			ScheduleTimeZone: pulumi.String("Eastern Time (US & Canada)"),
			ScheduleTimesOfDays: pulumi.StringArray{
				pulumi.String("06:30"),
			},
			Source:  pulumi.String("*.pdf"),
			Trigger: pulumi.String("daily"),
			TriggerActions: pulumi.StringArray{
				pulumi.String("create"),
			},
			WorkspaceId: pulumi.Int(0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;

return await Deployment.RunAsync(() => 
{
    var exampleAiTask = new Filescom.AiTask("example_ai_task", new()
    {
        Description = "Summarizes files uploaded by the accounting team.",
        Disabled = true,
        HolidayRegion = "us",
        Interval = "day",
        Name = "Summarize daily reports",
        Path = "incoming/reports",
        PermissionSet = "files_only",
        Prompt = "Summarize the uploaded file and identify follow-up actions.",
        RecurringDay = 1,
        RecurringDays = new[]
        {
            1,
            15,
        },
        ScheduleId = 1,
        ScheduleDaysOfWeeks = new[]
        {
            1,
            3,
            5,
        },
        ScheduleTimeZone = "Eastern Time (US & Canada)",
        ScheduleTimesOfDays = new[]
        {
            "06:30",
        },
        Source = "*.pdf",
        Trigger = "daily",
        TriggerActions = new[]
        {
            "create",
        },
        WorkspaceId = 0,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.AiTask;
import com.pulumi.filescom.AiTaskArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleAiTask = new AiTask("exampleAiTask", AiTaskArgs.builder()
            .description("Summarizes files uploaded by the accounting team.")
            .disabled(true)
            .holidayRegion("us")
            .interval("day")
            .name("Summarize daily reports")
            .path("incoming/reports")
            .permissionSet("files_only")
            .prompt("Summarize the uploaded file and identify follow-up actions.")
            .recurringDay(1)
            .recurringDays(            
                1,
                15)
            .scheduleId(1)
            .scheduleDaysOfWeeks(            
                1,
                3,
                5)
            .scheduleTimeZone("Eastern Time (US & Canada)")
            .scheduleTimesOfDays("06:30")
            .source("*.pdf")
            .trigger("daily")
            .triggerActions("create")
            .workspaceId(0)
            .build());

    }
}

    resources:
  exampleAiTask:
    type: filescom:AiTask
    name: example_ai_task
    properties:
      description: Summarizes files uploaded by the accounting team.
      disabled: true
      holidayRegion: us
      interval: day
      name: Summarize daily reports
      path: incoming/reports
      permissionSet: files_only
      prompt: Summarize the uploaded file and identify follow-up actions.
      recurringDay: 1
      recurringDays:
        - 1
        - 15
      scheduleId: 1
      scheduleDaysOfWeeks:
        - 1
        - 3
        - 5
      scheduleTimeZone: Eastern Time (US & Canada)
      scheduleTimesOfDays:
        - 06:30
      source: '*.pdf'
      trigger: daily
      triggerActions:
        - create
      workspaceId: 0

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

resource "filescom_aitask" "example_ai_task" {
  description            = "Summarizes files uploaded by the accounting team."
  disabled               = true
  holiday_region         = "us"
  interval               = "day"
  name                   = "Summarize daily reports"
  path                   = "incoming/reports"
  permission_set         = "files_only"
  prompt                 = "Summarize the uploaded file and identify follow-up actions."
  recurring_day          = 1
  recurring_days         = [1, 15]
  schedule_id            = 1
  schedule_days_of_weeks = [1, 3, 5]
  schedule_time_zone     = "Eastern Time (US & Canada)"
  schedule_times_of_days = ["06:30"]
  source                 = "*.pdf"
  trigger                = "daily"
  trigger_actions        = ["create"]
  workspace_id           = 0
}

    Create AiTask Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AiTask(name: string, args: AiTaskArgs, opts?: CustomResourceOptions);
    @overload
def AiTask(resource_name: str,
           args: AiTaskArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def AiTask(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           prompt: Optional[str] = None,
           recurring_day: Optional[int] = None,
           schedule_days_of_weeks: Optional[Sequence[int]] = None,
           interval: Optional[str] = None,
           name: Optional[str] = None,
           path: Optional[str] = None,
           permission_set: Optional[str] = None,
           disabled: Optional[bool] = None,
           description: Optional[str] = None,
           holiday_region: Optional[str] = None,
           schedule_id: Optional[int] = None,
           recurring_days: Optional[Sequence[int]] = None,
           schedule_time_zone: Optional[str] = None,
           schedule_times_of_days: Optional[Sequence[str]] = None,
           source: Optional[str] = None,
           trigger: Optional[str] = None,
           trigger_actions: Optional[Sequence[str]] = None,
           workspace_id: Optional[int] = None)
    func NewAiTask(ctx *Context, name string, args AiTaskArgs, opts ...ResourceOption) (*AiTask, error)
    public AiTask(string name, AiTaskArgs args, CustomResourceOptions? opts = null)
    public AiTask(String name, AiTaskArgs args)
public AiTask(String name, AiTaskArgs args, CustomResourceOptions options)

    type: filescom:AiTask
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "filescom_ai_task" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AiTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AiTaskArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AiTaskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AiTaskArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var aiTaskResource = new Filescom.AiTask("aiTaskResource", new()
{
    Prompt = "string",
    RecurringDay = 0,
    ScheduleDaysOfWeeks = new[]
    {
        0,
    },
    Interval = "string",
    Name = "string",
    Path = "string",
    PermissionSet = "string",
    Disabled = false,
    Description = "string",
    HolidayRegion = "string",
    ScheduleId = 0,
    RecurringDays = new[]
    {
        0,
    },
    ScheduleTimeZone = "string",
    ScheduleTimesOfDays = new[]
    {
        "string",
    },
    Source = "string",
    Trigger = "string",
    TriggerActions = new[]
    {
        "string",
    },
    WorkspaceId = 0,
});

    example, err := filescom.NewAiTask(ctx, "aiTaskResource", &filescom.AiTaskArgs{
	Prompt:       pulumi.String("string"),
	RecurringDay: pulumi.Int(0),
	ScheduleDaysOfWeeks: pulumi.IntArray{
		pulumi.Int(0),
	},
	Interval:      pulumi.String("string"),
	Name:          pulumi.String("string"),
	Path:          pulumi.String("string"),
	PermissionSet: pulumi.String("string"),
	Disabled:      pulumi.Bool(false),
	Description:   pulumi.String("string"),
	HolidayRegion: pulumi.String("string"),
	ScheduleId:    pulumi.Int(0),
	RecurringDays: pulumi.IntArray{
		pulumi.Int(0),
	},
	ScheduleTimeZone: pulumi.String("string"),
	ScheduleTimesOfDays: pulumi.StringArray{
		pulumi.String("string"),
	},
	Source:  pulumi.String("string"),
	Trigger: pulumi.String("string"),
	TriggerActions: pulumi.StringArray{
		pulumi.String("string"),
	},
	WorkspaceId: pulumi.Int(0),
})

    resource "filescom_ai_task" "aiTaskResource" {
  lifecycle {
    create_before_destroy = true
  }
  prompt                 = "string"
  recurring_day          = 0
  schedule_days_of_weeks = [0]
  interval               = "string"
  name                   = "string"
  path                   = "string"
  permission_set         = "string"
  disabled               = false
  description            = "string"
  holiday_region         = "string"
  schedule_id            = 0
  recurring_days         = [0]
  schedule_time_zone     = "string"
  schedule_times_of_days = ["string"]
  source                 = "string"
  trigger                = "string"
  trigger_actions        = ["string"]
  workspace_id           = 0
}

    var aiTaskResource = new AiTask("aiTaskResource", AiTaskArgs.builder()
    .prompt("string")
    .recurringDay(0)
    .scheduleDaysOfWeeks(0)
    .interval("string")
    .name("string")
    .path("string")
    .permissionSet("string")
    .disabled(false)
    .description("string")
    .holidayRegion("string")
    .scheduleId(0)
    .recurringDays(0)
    .scheduleTimeZone("string")
    .scheduleTimesOfDays("string")
    .source("string")
    .trigger("string")
    .triggerActions("string")
    .workspaceId(0)
    .build());

    ai_task_resource = filescom.AiTask("aiTaskResource",
    prompt="string",
    recurring_day=0,
    schedule_days_of_weeks=[0],
    interval="string",
    name="string",
    path="string",
    permission_set="string",
    disabled=False,
    description="string",
    holiday_region="string",
    schedule_id=0,
    recurring_days=[0],
    schedule_time_zone="string",
    schedule_times_of_days=["string"],
    source="string",
    trigger="string",
    trigger_actions=["string"],
    workspace_id=0)

    const aiTaskResource = new filescom.AiTask("aiTaskResource", {
    prompt: "string",
    recurringDay: 0,
    scheduleDaysOfWeeks: [0],
    interval: "string",
    name: "string",
    path: "string",
    permissionSet: "string",
    disabled: false,
    description: "string",
    holidayRegion: "string",
    scheduleId: 0,
    recurringDays: [0],
    scheduleTimeZone: "string",
    scheduleTimesOfDays: ["string"],
    source: "string",
    trigger: "string",
    triggerActions: ["string"],
    workspaceId: 0,
});

    type: filescom:AiTask
properties:
    description: string
    disabled: false
    holidayRegion: string
    interval: string
    name: string
    path: string
    permissionSet: string
    prompt: string
    recurringDay: 0
    recurringDays:
        - 0
    scheduleDaysOfWeeks:
        - 0
    scheduleId: 0
    scheduleTimeZone: string
    scheduleTimesOfDays:
        - string
    source: string
    trigger: string
    triggerActions:
        - string
    workspaceId: 0

    AiTask Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AiTask resource accepts the following input properties:

    Prompt string
    Prompt sent when this AI Task is invoked.
    Description string
    AI Task description.
    Disabled bool
    If true, this AI Task will not run.
    HolidayRegion string
    Optional holiday region used by the AI Task schedule.
    Interval string
    If trigger is daily, this specifies how often to run the AI Task.
    Name string
    AI Task name.
    Path string
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    PermissionSet string
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays List<int>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ScheduleDaysOfWeeks List<int>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    ScheduleTimeZone string
    Time zone used by the AI Task schedule.
    ScheduleTimesOfDays List<string>
    Times of day in HH:MM format for the AI Task schedule.
    Source string
    Source glob used with path for action-triggered AI Tasks.
    Trigger string
    How this AI Task is triggered.
    TriggerActions List<string>
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    Prompt string
    Prompt sent when this AI Task is invoked.
    Description string
    AI Task description.
    Disabled bool
    If true, this AI Task will not run.
    HolidayRegion string
    Optional holiday region used by the AI Task schedule.
    Interval string
    If trigger is daily, this specifies how often to run the AI Task.
    Name string
    AI Task name.
    Path string
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    PermissionSet string
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays []int
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ScheduleDaysOfWeeks []int
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    ScheduleTimeZone string
    Time zone used by the AI Task schedule.
    ScheduleTimesOfDays []string
    Times of day in HH:MM format for the AI Task schedule.
    Source string
    Source glob used with path for action-triggered AI Tasks.
    Trigger string
    How this AI Task is triggered.
    TriggerActions []string
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    prompt string
    Prompt sent when this AI Task is invoked.
    description string
    AI Task description.
    disabled bool
    If true, this AI Task will not run.
    holiday_region string
    Optional holiday region used by the AI Task schedule.
    interval string
    If trigger is daily, this specifies how often to run the AI Task.
    name string
    AI Task name.
    path string
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission_set string
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    recurring_day number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days list(number)
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    schedule_days_of_weeks list(number)
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id number
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    schedule_time_zone string
    Time zone used by the AI Task schedule.
    schedule_times_of_days list(string)
    Times of day in HH:MM format for the AI Task schedule.
    source string
    Source glob used with path for action-triggered AI Tasks.
    trigger string
    How this AI Task is triggered.
    trigger_actions list(string)
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    workspace_id number
    Workspace ID. 0 means the default workspace.
    prompt String
    Prompt sent when this AI Task is invoked.
    description String
    AI Task description.
    disabled Boolean
    If true, this AI Task will not run.
    holidayRegion String
    Optional holiday region used by the AI Task schedule.
    interval String
    If trigger is daily, this specifies how often to run the AI Task.
    name String
    AI Task name.
    path String
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permissionSet String
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    recurringDay Integer
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Integer>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks List<Integer>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Integer
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    scheduleTimeZone String
    Time zone used by the AI Task schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the AI Task schedule.
    source String
    Source glob used with path for action-triggered AI Tasks.
    trigger String
    How this AI Task is triggered.
    triggerActions List<String>
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    prompt string
    Prompt sent when this AI Task is invoked.
    description string
    AI Task description.
    disabled boolean
    If true, this AI Task will not run.
    holidayRegion string
    Optional holiday region used by the AI Task schedule.
    interval string
    If trigger is daily, this specifies how often to run the AI Task.
    name string
    AI Task name.
    path string
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permissionSet string
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    recurringDay number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays number[]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks number[]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId number
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    scheduleTimeZone string
    Time zone used by the AI Task schedule.
    scheduleTimesOfDays string[]
    Times of day in HH:MM format for the AI Task schedule.
    source string
    Source glob used with path for action-triggered AI Tasks.
    trigger string
    How this AI Task is triggered.
    triggerActions string[]
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    workspaceId number
    Workspace ID. 0 means the default workspace.
    prompt str
    Prompt sent when this AI Task is invoked.
    description str
    AI Task description.
    disabled bool
    If true, this AI Task will not run.
    holiday_region str
    Optional holiday region used by the AI Task schedule.
    interval str
    If trigger is daily, this specifies how often to run the AI Task.
    name str
    AI Task name.
    path str
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission_set str
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    recurring_day int
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days Sequence[int]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    schedule_days_of_weeks Sequence[int]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id int
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    schedule_time_zone str
    Time zone used by the AI Task schedule.
    schedule_times_of_days Sequence[str]
    Times of day in HH:MM format for the AI Task schedule.
    source str
    Source glob used with path for action-triggered AI Tasks.
    trigger str
    How this AI Task is triggered.
    trigger_actions Sequence[str]
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    workspace_id int
    Workspace ID. 0 means the default workspace.
    prompt String
    Prompt sent when this AI Task is invoked.
    description String
    AI Task description.
    disabled Boolean
    If true, this AI Task will not run.
    holidayRegion String
    Optional holiday region used by the AI Task schedule.
    interval String
    If trigger is daily, this specifies how often to run the AI Task.
    name String
    AI Task name.
    path String
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permissionSet String
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    recurringDay Number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Number>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks List<Number>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Number
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    scheduleTimeZone String
    Time zone used by the AI Task schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the AI Task schedule.
    source String
    Source glob used with path for action-triggered AI Tasks.
    trigger String
    How this AI Task is triggered.
    triggerActions List<String>
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AiTask resource produces the following output properties:

    CreatedAt string
    Creation time.
    HumanReadableSchedule string
    Human-readable schedule description.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastRunAt string
    Most recent successful invocation time.
    MasterAdminUserId int
    Master User ID used for AI Task invocations.
    UpdatedAt string
    Last update time.
    CreatedAt string
    Creation time.
    HumanReadableSchedule string
    Human-readable schedule description.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastRunAt string
    Most recent successful invocation time.
    MasterAdminUserId int
    Master User ID used for AI Task invocations.
    UpdatedAt string
    Last update time.
    created_at string
    Creation time.
    human_readable_schedule string
    Human-readable schedule description.
    id string
    The provider-assigned unique ID for this managed resource.
    last_run_at string
    Most recent successful invocation time.
    master_admin_user_id number
    Master User ID used for AI Task invocations.
    updated_at string
    Last update time.
    createdAt String
    Creation time.
    humanReadableSchedule String
    Human-readable schedule description.
    id String
    The provider-assigned unique ID for this managed resource.
    lastRunAt String
    Most recent successful invocation time.
    masterAdminUserId Integer
    Master User ID used for AI Task invocations.
    updatedAt String
    Last update time.
    createdAt string
    Creation time.
    humanReadableSchedule string
    Human-readable schedule description.
    id string
    The provider-assigned unique ID for this managed resource.
    lastRunAt string
    Most recent successful invocation time.
    masterAdminUserId number
    Master User ID used for AI Task invocations.
    updatedAt string
    Last update time.
    created_at str
    Creation time.
    human_readable_schedule str
    Human-readable schedule description.
    id str
    The provider-assigned unique ID for this managed resource.
    last_run_at str
    Most recent successful invocation time.
    master_admin_user_id int
    Master User ID used for AI Task invocations.
    updated_at str
    Last update time.
    createdAt String
    Creation time.
    humanReadableSchedule String
    Human-readable schedule description.
    id String
    The provider-assigned unique ID for this managed resource.
    lastRunAt String
    Most recent successful invocation time.
    masterAdminUserId Number
    Master User ID used for AI Task invocations.
    updatedAt String
    Last update time.

    Look up Existing AiTask Resource

    Get an existing AiTask resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AiTaskState, opts?: CustomResourceOptions): AiTask
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        disabled: Optional[bool] = None,
        holiday_region: Optional[str] = None,
        human_readable_schedule: Optional[str] = None,
        interval: Optional[str] = None,
        last_run_at: Optional[str] = None,
        master_admin_user_id: Optional[int] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        permission_set: Optional[str] = None,
        prompt: Optional[str] = None,
        recurring_day: Optional[int] = None,
        recurring_days: Optional[Sequence[int]] = None,
        schedule_days_of_weeks: Optional[Sequence[int]] = None,
        schedule_id: Optional[int] = None,
        schedule_time_zone: Optional[str] = None,
        schedule_times_of_days: Optional[Sequence[str]] = None,
        source: Optional[str] = None,
        trigger: Optional[str] = None,
        trigger_actions: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None,
        workspace_id: Optional[int] = None) -> AiTask
    func GetAiTask(ctx *Context, name string, id IDInput, state *AiTaskState, opts ...ResourceOption) (*AiTask, error)
    public static AiTask Get(string name, Input<string> id, AiTaskState? state, CustomResourceOptions? opts = null)
    public static AiTask get(String name, Output<String> id, AiTaskState state, CustomResourceOptions options)
    resources:  _:    type: filescom:AiTask    get:      id: ${id}
    import {
  to = filescom_ai_task.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    Creation time.
    Description string
    AI Task description.
    Disabled bool
    If true, this AI Task will not run.
    HolidayRegion string
    Optional holiday region used by the AI Task schedule.
    HumanReadableSchedule string
    Human-readable schedule description.
    Interval string
    If trigger is daily, this specifies how often to run the AI Task.
    LastRunAt string
    Most recent successful invocation time.
    MasterAdminUserId int
    Master User ID used for AI Task invocations.
    Name string
    AI Task name.
    Path string
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    PermissionSet string
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    Prompt string
    Prompt sent when this AI Task is invoked.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays List<int>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ScheduleDaysOfWeeks List<int>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    ScheduleTimeZone string
    Time zone used by the AI Task schedule.
    ScheduleTimesOfDays List<string>
    Times of day in HH:MM format for the AI Task schedule.
    Source string
    Source glob used with path for action-triggered AI Tasks.
    Trigger string
    How this AI Task is triggered.
    TriggerActions List<string>
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    UpdatedAt string
    Last update time.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    CreatedAt string
    Creation time.
    Description string
    AI Task description.
    Disabled bool
    If true, this AI Task will not run.
    HolidayRegion string
    Optional holiday region used by the AI Task schedule.
    HumanReadableSchedule string
    Human-readable schedule description.
    Interval string
    If trigger is daily, this specifies how often to run the AI Task.
    LastRunAt string
    Most recent successful invocation time.
    MasterAdminUserId int
    Master User ID used for AI Task invocations.
    Name string
    AI Task name.
    Path string
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    PermissionSet string
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    Prompt string
    Prompt sent when this AI Task is invoked.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays []int
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ScheduleDaysOfWeeks []int
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    ScheduleTimeZone string
    Time zone used by the AI Task schedule.
    ScheduleTimesOfDays []string
    Times of day in HH:MM format for the AI Task schedule.
    Source string
    Source glob used with path for action-triggered AI Tasks.
    Trigger string
    How this AI Task is triggered.
    TriggerActions []string
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    UpdatedAt string
    Last update time.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    created_at string
    Creation time.
    description string
    AI Task description.
    disabled bool
    If true, this AI Task will not run.
    holiday_region string
    Optional holiday region used by the AI Task schedule.
    human_readable_schedule string
    Human-readable schedule description.
    interval string
    If trigger is daily, this specifies how often to run the AI Task.
    last_run_at string
    Most recent successful invocation time.
    master_admin_user_id number
    Master User ID used for AI Task invocations.
    name string
    AI Task name.
    path string
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission_set string
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    prompt string
    Prompt sent when this AI Task is invoked.
    recurring_day number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days list(number)
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    schedule_days_of_weeks list(number)
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id number
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    schedule_time_zone string
    Time zone used by the AI Task schedule.
    schedule_times_of_days list(string)
    Times of day in HH:MM format for the AI Task schedule.
    source string
    Source glob used with path for action-triggered AI Tasks.
    trigger string
    How this AI Task is triggered.
    trigger_actions list(string)
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    updated_at string
    Last update time.
    workspace_id number
    Workspace ID. 0 means the default workspace.
    createdAt String
    Creation time.
    description String
    AI Task description.
    disabled Boolean
    If true, this AI Task will not run.
    holidayRegion String
    Optional holiday region used by the AI Task schedule.
    humanReadableSchedule String
    Human-readable schedule description.
    interval String
    If trigger is daily, this specifies how often to run the AI Task.
    lastRunAt String
    Most recent successful invocation time.
    masterAdminUserId Integer
    Master User ID used for AI Task invocations.
    name String
    AI Task name.
    path String
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permissionSet String
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    prompt String
    Prompt sent when this AI Task is invoked.
    recurringDay Integer
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Integer>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks List<Integer>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Integer
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    scheduleTimeZone String
    Time zone used by the AI Task schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the AI Task schedule.
    source String
    Source glob used with path for action-triggered AI Tasks.
    trigger String
    How this AI Task is triggered.
    triggerActions List<String>
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    updatedAt String
    Last update time.
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    createdAt string
    Creation time.
    description string
    AI Task description.
    disabled boolean
    If true, this AI Task will not run.
    holidayRegion string
    Optional holiday region used by the AI Task schedule.
    humanReadableSchedule string
    Human-readable schedule description.
    interval string
    If trigger is daily, this specifies how often to run the AI Task.
    lastRunAt string
    Most recent successful invocation time.
    masterAdminUserId number
    Master User ID used for AI Task invocations.
    name string
    AI Task name.
    path string
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permissionSet string
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    prompt string
    Prompt sent when this AI Task is invoked.
    recurringDay number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays number[]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks number[]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId number
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    scheduleTimeZone string
    Time zone used by the AI Task schedule.
    scheduleTimesOfDays string[]
    Times of day in HH:MM format for the AI Task schedule.
    source string
    Source glob used with path for action-triggered AI Tasks.
    trigger string
    How this AI Task is triggered.
    triggerActions string[]
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    updatedAt string
    Last update time.
    workspaceId number
    Workspace ID. 0 means the default workspace.
    created_at str
    Creation time.
    description str
    AI Task description.
    disabled bool
    If true, this AI Task will not run.
    holiday_region str
    Optional holiday region used by the AI Task schedule.
    human_readable_schedule str
    Human-readable schedule description.
    interval str
    If trigger is daily, this specifies how often to run the AI Task.
    last_run_at str
    Most recent successful invocation time.
    master_admin_user_id int
    Master User ID used for AI Task invocations.
    name str
    AI Task name.
    path str
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission_set str
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    prompt str
    Prompt sent when this AI Task is invoked.
    recurring_day int
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days Sequence[int]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    schedule_days_of_weeks Sequence[int]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id int
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    schedule_time_zone str
    Time zone used by the AI Task schedule.
    schedule_times_of_days Sequence[str]
    Times of day in HH:MM format for the AI Task schedule.
    source str
    Source glob used with path for action-triggered AI Tasks.
    trigger str
    How this AI Task is triggered.
    trigger_actions Sequence[str]
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    updated_at str
    Last update time.
    workspace_id int
    Workspace ID. 0 means the default workspace.
    createdAt String
    Creation time.
    description String
    AI Task description.
    disabled Boolean
    If true, this AI Task will not run.
    holidayRegion String
    Optional holiday region used by the AI Task schedule.
    humanReadableSchedule String
    Human-readable schedule description.
    interval String
    If trigger is daily, this specifies how often to run the AI Task.
    lastRunAt String
    Most recent successful invocation time.
    masterAdminUserId Number
    Master User ID used for AI Task invocations.
    name String
    AI Task name.
    path String
    Path scope used for action-triggered AI Tasks. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permissionSet String
    Permissions used by the internal API key for this AI Task. Valid values are full and filesOnly.
    prompt String
    Prompt sent when this AI Task is invoked.
    recurringDay Number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Number>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    scheduleDaysOfWeeks List<Number>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Number
    If trigger is customSchedule, the reusable Schedule used instead of the AI Task's schedule fields.
    scheduleTimeZone String
    Time zone used by the AI Task schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the AI Task schedule.
    source String
    Source glob used with path for action-triggered AI Tasks.
    trigger String
    How this AI Task is triggered.
    triggerActions List<String>
    If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
    updatedAt String
    Last update time.
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Import

    The pulumi import command can be used, for example:

    Ai Tasks can be imported by specifying the id.

    $ pulumi import filescom:index/aiTask:AiTask example_ai_task 1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial