Quick Start

Deploy your first Ariftly agent in under 5 minutes.

Prerequisites

• An Ariftly account (sign up at app.ariftly.io)
• At least one integration connected (GitHub, Slack, or Gmail)

Step 1: Get your API key

1. Log into the Ariftly Dashboard
2. Go to Settings → API Keys → Generate New Key
3. Copy your key — you won't see it again

Step 2: Connect an integration

Go to Integrations in the dashboard and connect a tool:

• GitHub — repository access, PR creation
• Gmail — Sales Agent email workflows
• Slack — notifications and channel approvals

All credentials are stored encrypted. Agents never receive raw tokens.

Step 3: Deploy an agent

curl -X POST https://api.ariftly.io/v1/agents/deploy \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"agent_slug": "ai-readiness-agent", "name": "My AI Readiness Agent"}'

Response:

{"agent_id": "agent_abc123", "status": "active"}

Step 4: Trigger a task

curl -X POST https://api.ariftly.io/v1/tasks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"agent_id": "agent_abc123", "task_type": "ai_readiness.full_audit", "input": {"scope": "full"}}'

Response:

{"task_id": "task_xyz789", "status": "running"}

Step 5: Check results

curl https://api.ariftly.io/v1/tasks/task_xyz789 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "status": "complete",
  "artifacts": [{
    "type": "ai_readiness.audit_report",
    "summary": "EU AI Act: 14 gaps found. 3 critical.",
    "url": "https://app.ariftly.io/artifacts/art_001"
  }]
}

What's next?

• Deploy Your First Agent — step-by-step dashboard walkthrough
• AI Readiness Agent — full agent capabilities
• Core Concepts — tasks, artifacts, approvals