Quickstart

This guide walks you through getting an API key, provisioning a cloud computer, and running your first AI agent task — all in under five minutes.

1. Get your API key

  1. Sign in at build.withgiga.ai
  2. Navigate to Profile in the left sidebar
  3. Click Generate API Key
  4. Copy the key — it starts with giga_sk_ and is shown only once
Store your API key securely. Do not commit it to source control or expose it in client-side code.

2. Start a deployment and run an agent

The /api/deployments/start endpoint provisions a cloud computer and immediately kicks off an AI agent in a single call.
curl -X POST https://api.withgiga.ai/api/deployments/start \
  -H "Authorization: Bearer giga_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My First Agent",
    "platform": "giga-standard",
    "duration": 1,
    "aiEnabled": true,
    "prompts": {
      "userPrompt": "Go to https://news.ycombinator.com and find the top story.",
      "goalPrompt": "Save the title of the top story to a file called result.txt on the Desktop."
    }
  }'
Response
{
  "success": true,
  "data": {
    "deployment": {
      "id": "dep_abc123",
      "status": "provisioning",
      "platform": "giga-standard"
    },
    "session": {
      "threadId": "3b2a1f9c-...",
      "sandboxId": "sbx_789",
      "vncUrl": "wss://..."
    }
  }
}
Save the deployment.id — you’ll use it to poll for status.

3. Poll for completion

Provisioning and execution happen asynchronously. Poll every few seconds until status is running or completed.
curl https://api.withgiga.ai/api/deployments/dep_abc123 \
  -H "Authorization: Bearer giga_sk_YOUR_KEY"
StatusMeaning
provisioningVM is booting, agent is queued
runningAgent is actively executing
completedAgent finished its goal
failedSomething went wrong — check logs

4. Retrieve the result

Once the agent completes, download any files it produced from the sandbox Desktop.
# List files in the deployment
curl "https://api.withgiga.ai/api/files?deploymentId=dep_abc123" \
  -H "Authorization: Bearer giga_sk_YOUR_KEY"

# Get a download URL for a specific file
curl "https://api.withgiga.ai/api/files/download?fileId=file_xxx" \
  -H "Authorization: Bearer giga_sk_YOUR_KEY"

5. Clean up

Stop the deployment when you’re done to stop credit consumption.
curl -X POST https://api.withgiga.ai/api/deployments/dep_abc123/session/stop \
  -H "Authorization: Bearer giga_sk_YOUR_KEY"

Next steps

Core Concepts

Understand the full object model before going deeper.

API Reference

Explore every endpoint with full request and response schemas.

Files Guide

Learn how to sync files in and out of the sandbox.

Dashboard

Prefer a UI? Use the web dashboard to launch computers without code.