1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getAiTask
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    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 = filescom.getAiTask({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_ai_task = filescom.get_ai_task(id=1)
    
    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.GetAiTask(ctx, &filescom.LookupAiTaskArgs{
    			Id: 1,
    		}, nil)
    		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 = Filescom.GetAiTask.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetAiTaskArgs;
    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) {
            final var exampleAiTask = FilescomFunctions.getAiTask(GetAiTaskArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleAiTask:
        fn::invoke:
          function: filescom:getAiTask
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getaitask" "exampleAiTask" {
      id = 1
    }
    

    Using getAiTask

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAiTask(args: GetAiTaskArgs, opts?: InvokeOptions): Promise<GetAiTaskResult>
    function getAiTaskOutput(args: GetAiTaskOutputArgs, opts?: InvokeOutputOptions): Output<GetAiTaskResult>
    def get_ai_task(id: Optional[int] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAiTaskResult
    def get_ai_task_output(id: pulumi.Input[Optional[int]] = None,
                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetAiTaskResult]
    func LookupAiTask(ctx *Context, args *LookupAiTaskArgs, opts ...InvokeOption) (*LookupAiTaskResult, error)
    func LookupAiTaskOutput(ctx *Context, args *LookupAiTaskOutputArgs, opts ...InvokeOption) LookupAiTaskResultOutput

    > Note: This function is named LookupAiTask in the Go SDK.

    public static class GetAiTask 
    {
        public static Task<GetAiTaskResult> InvokeAsync(GetAiTaskArgs args, InvokeOptions? opts = null)
        public static Output<GetAiTaskResult> Invoke(GetAiTaskInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetAiTaskResult> Invoke(GetAiTaskInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetAiTaskResult> getAiTask(GetAiTaskArgs args, InvokeOptions options)
    public static Output<GetAiTaskResult> getAiTask(GetAiTaskArgs args, InvokeOptions options)
    public static Output<GetAiTaskResult> getAiTask(GetAiTaskArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getAiTask:getAiTask
      arguments:
        # arguments dictionary
    data "filescom_get_ai_task" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    AI Task ID.
    Id int
    AI Task ID.
    id number
    AI Task ID.
    id Integer
    AI Task ID.
    id number
    AI Task ID.
    id int
    AI Task ID.
    id Number
    AI Task ID.

    getAiTask Result

    The following output properties are available:

    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.
    Id int
    AI Task ID.
    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.
    Id int
    AI Task ID.
    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.
    id number
    AI Task ID.
    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.
    id Integer
    AI Task ID.
    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.
    id number
    AI Task ID.
    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.
    id int
    AI Task ID.
    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.
    id Number
    AI Task ID.
    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.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial