Pulumi Copilot API Overview

{
    "query": string,
    "state": {
        "client": {
            "cloudContext": {
                "orgId": string,
                "url": string
            }
        }
    }
}

{
    "conversationId": string,
    "messages": [
        {
            "role": string,
            "kind": string,
            "content": string | object
        }
    ]
}

{
    "code": string,
    "plan": {
        "instructions": string
    },
    "language": string,
    "programId": string
}

curl -L https://api.pulumi.com/api/ai/chat/preview \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "query": "Analyze this update. If it failed, tell me how to resolve the issues.",
    "state": {
        "client": {
            "cloudContext": {
                "orgId": "myorg",
                "url": "https://app.pulumi.com/myorg/project1/dev/updates/4"
            }
        }
    }
}'

{
  "conversationId": "522e0fdb-e992-4be4-9937-37249ed93289",
  "messages": [
    {
      "role": "user",
      "kind": "response",
      "content": "Analyze this update. If it failed, tell me how to resolve the issues."
    },
    {
      "role": "assistant",
      "kind": "trace",
      "content": "Conversation with user 'john' in org 'myorg' from console (rest-api-v2)"
    },
    {
      "role": "assistant",
      "kind": "status",
      "content": "Executing Pulumi Cloud skill"
    },
    {
      "role": "assistant",
      "kind": "response",
      "content": "The update for the stack 'project1/dev' has failed. The failure is due to an error in creating a Virtual Network resource in Azure. The specific error is related to the incorrect handling of an Output<T> type in Pulumi. The error message indicates that calling 'ToString' on an Output<T> is not supported, which leads to a bad request error (HTTP 400) when trying to create the resource.\n\n**How to resolve the issue:**\n- Review the code where the resourceGroupName is being set. Ensure that you are not directly converting an Output<T> to a string using 'ToString'.\n- Use the 'Apply' method or 'Output.Format' to correctly handle the Output<T> type. For example, use `o.Apply(v => $\"prefix{v}suffix\")` or `Output.Format($\"prefix{hostname}suffix\")`.\n- Refer to the Pulumi documentation on [Inputs and Outputs](https://www.pulumi.com/docs/concepts/inputs-outputs) for more guidance on handling Output<T> types properly."
    }
  ]
}

curl -L https://api.pulumi.com/api/ai/chat/preview \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "query": "Write code to create an S3 bucket",
    "state": {
        "client": {
            "cloudContext": {
                "orgId": "myorg",
                "url": "https://app.pulumi.com"
            }
        }
    }
}'

{
  "conversationId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6",
  "messages": [
    // omitted for brevity
    // ...
    {
      "role": "assistant",
      "kind": "program",
      "content": {
        "code": "import * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\n// Create an S3 bucket\nconst bucket = new aws.s3.Bucket(\"my-bucket\", {\n    bucket: \"my-unique-bucket-name\",\n    acl: \"private\",\n});\n\n// Export the name of the bucket\nexport const bucketName = bucket.bucket;",
        "plan": {
          "instructions": "1. Install Pulumi CLI and AWS SDK.\n2. Create a new Pulumi project.\n3. Write the Pulumi program to define an S3 bucket resource.\n4. Deploy the stack using `pulumi up`.\n\nHere is the code to create an S3 bucket using Pulumi in TypeScript:"
        },
        "language": "typescript",
        "programId": "pn7Gfod"
      }
    }
  ]
}

{
    "query": string,
    "state": {
        "client": {
            "cloudContext": {
                "orgId": string,
                "url": string
            }
        }
    },
    "conversationId": string
}

curl -L https://api.pulumi.com/api/ai/chat/preview \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "query": "Why can I not directly convert an Output<T> to a string?",
    "state": {
        "client": {
            "cloudContext": {
                "orgId": "myorg",
                "url": "https://app.pulumi.com/myorg/project1/dev/updates/4"
            }
        }
    },
    "conversationId":"522e0fdb-e992-4be4-9937-37249ed93289"
}'

{
  "conversationId": "522e0fdb-e992-4be4-9937-37249ed93289",
  "messages": [
    // omitted for brevity
    // ...
    {
      "role": "assistant",
      "kind": "status",
      "content": "Executing Pulumi Docs skill"
    },
    {
      "role": "assistant",
      "kind": "response",
      "content": "In Pulumi, an `Output<T>` represents a value that is computed asynchronously, which means the actual value isn't available until the resource is provisioned. This is why you can't directly convert an `Output<T>` to a string. Instead, you should use the `apply` method to specify a function that will be executed once the value is available. This ensures that any code dependent on the `Output`'s value only runs after the value is resolved.\n\nHere's a brief example in TypeScript:\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\n\nconst bucket = new aws.s3.Bucket(\"my-bucket\");\n\nconst bucketNameString: pulumi.Output<string> = bucket.id.apply(id => {\n    if (typeof id === 'string') return id;\n    throw new Error(`Expected a string but got: ${id}`);\n});\n```\n\nIn this example, `bucket.id` is an `Output`. The `apply` method is used to transform it into a string. For more information, you can refer to Pulumi's documentation on [Outputs](https://www.pulumi.com/docs/intro/concepts/inputs-outputs/)."
    }
  ]
}