1. Packages
  2. Coder Provider
  3. API Docs
  4. AiTask
coder 2.12.0 published on Tuesday, Oct 21, 2025 by coder
coder/terraform-provider-coder

coder.AiTask

Get Started
coder logo
coder 2.12.0 published on Tuesday, Oct 21, 2025 by coder
coder/terraform-provider-coder

    Use this resource to define Coder tasks.

    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: Optional[AiTaskArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def AiTask(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           app_id: Optional[str] = None,
           sidebar_app: Optional[AiTaskSidebarAppArgs] = None)
    func NewAiTask(ctx *Context, name string, args *AiTaskArgs, opts ...ResourceOption) (*AiTask, error)
    public AiTask(string name, AiTaskArgs? args = null, CustomResourceOptions? opts = null)
    public AiTask(String name, AiTaskArgs args)
public AiTask(String name, AiTaskArgs args, CustomResourceOptions options)

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

    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 Coder.AiTask("aiTaskResource", new()
{
    AppId = "string",
});

    example, err := coder.NewAiTask(ctx, "aiTaskResource", &coder.AiTaskArgs{
	AppId: pulumi.String("string"),
})

    var aiTaskResource = new AiTask("aiTaskResource", AiTaskArgs.builder()
    .appId("string")
    .build());

    ai_task_resource = coder.AiTask("aiTaskResource", app_id="string")

    const aiTaskResource = new coder.AiTask("aiTaskResource", {appId: "string"});

    type: coder:AiTask
properties:
    appId: string

    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:

    AppId string
    The ID of the coder.App resource that provides the AI interface for this task.
    SidebarApp AiTaskSidebarApp
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    AppId string
    The ID of the coder.App resource that provides the AI interface for this task.
    SidebarApp AiTaskSidebarAppArgs
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    appId String
    The ID of the coder.App resource that provides the AI interface for this task.
    sidebarApp AiTaskSidebarApp
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    appId string
    The ID of the coder.App resource that provides the AI interface for this task.
    sidebarApp AiTaskSidebarApp
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    app_id str
    The ID of the coder.App resource that provides the AI interface for this task.
    sidebar_app AiTaskSidebarAppArgs
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    appId String
    The ID of the coder.App resource that provides the AI interface for this task.
    sidebarApp Property Map
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Prompt string
    The prompt text provided to the task by Coder.
    Id string
    The provider-assigned unique ID for this managed resource.
    Prompt string
    The prompt text provided to the task by Coder.
    id String
    The provider-assigned unique ID for this managed resource.
    prompt String
    The prompt text provided to the task by Coder.
    id string
    The provider-assigned unique ID for this managed resource.
    prompt string
    The prompt text provided to the task by Coder.
    id str
    The provider-assigned unique ID for this managed resource.
    prompt str
    The prompt text provided to the task by Coder.
    id String
    The provider-assigned unique ID for this managed resource.
    prompt String
    The prompt text provided to the task by Coder.

    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,
        app_id: Optional[str] = None,
        prompt: Optional[str] = None,
        sidebar_app: Optional[AiTaskSidebarAppArgs] = 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: coder:AiTask    get:      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:
    AppId string
    The ID of the coder.App resource that provides the AI interface for this task.
    Prompt string
    The prompt text provided to the task by Coder.
    SidebarApp AiTaskSidebarApp
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    AppId string
    The ID of the coder.App resource that provides the AI interface for this task.
    Prompt string
    The prompt text provided to the task by Coder.
    SidebarApp AiTaskSidebarAppArgs
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    appId String
    The ID of the coder.App resource that provides the AI interface for this task.
    prompt String
    The prompt text provided to the task by Coder.
    sidebarApp AiTaskSidebarApp
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    appId string
    The ID of the coder.App resource that provides the AI interface for this task.
    prompt string
    The prompt text provided to the task by Coder.
    sidebarApp AiTaskSidebarApp
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    app_id str
    The ID of the coder.App resource that provides the AI interface for this task.
    prompt str
    The prompt text provided to the task by Coder.
    sidebar_app AiTaskSidebarAppArgs
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    appId String
    The ID of the coder.App resource that provides the AI interface for this task.
    prompt String
    The prompt text provided to the task by Coder.
    sidebarApp Property Map
    The coder*app to display in the sidebar. Usually a chat interface with the AI agent running in the workspace, like https://github.com/coder/agentapi.

    Deprecated: Deprecated

    Supporting Types

    AiTaskSidebarApp, AiTaskSidebarAppArgs

    Id string
    A reference to an existing coder.App resource in your template.
    Id string
    A reference to an existing coder.App resource in your template.
    id String
    A reference to an existing coder.App resource in your template.
    id string
    A reference to an existing coder.App resource in your template.
    id str
    A reference to an existing coder.App resource in your template.
    id String
    A reference to an existing coder.App resource in your template.

    Package Details

    Repository
    coder coder/terraform-provider-coder
    License
    Notes
    This Pulumi package is based on the coder Terraform Provider.
    coder logo
    coder 2.12.0 published on Tuesday, Oct 21, 2025 by coder
    coder/terraform-provider-coder
      Meet Neo: Your AI Platform Teammate