Quick Start

Get your first Ariftly scan running in under 5 minutes.

Prerequisites

• An Ariftly account (sign up at app.ariftly.io)
• A target URL or repository you want to scan

Step 1: Get your API key

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

Store it securely. Never commit it to source control.

Step 2: Create a project

In the dashboard, click New Project, give it a name, and choose your target type:

• URL — scan a live web application
• Repository — scan a GitHub/GitLab repository
• API — scan a REST or GraphQL API endpoint

Or via the API:

curl -X POST https://api.ariftly.io/v1/projects \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Application",
    "target_type": "url",
    "target": "https://myapp.example.com"
  }'

Response:

{
  "id": "proj_abc123",
  "name": "My Application",
  "target_type": "url",
  "target": "https://myapp.example.com",
  "created_at": "2026-03-25T10:00:00Z"
}

Step 3: Trigger a scan

Start a scan with the detectors you want:

curl -X POST https://api.ariftly.io/v1/projects/proj_abc123/scans \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "detectors": ["accessibility", "security", "ai_readiness"]
  }'

Response:

{
  "scan_id": "scan_xyz789",
  "status": "running",
  "detectors": ["accessibility", "security", "ai_readiness"],
  "created_at": "2026-03-25T10:01:00Z"
}

Step 4: Get results

Poll for results or use a webhook:

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

Response:

{
  "scan_id": "scan_xyz789",
  "status": "completed",
  "risk_score": 72,
  "risk_level": "medium",
  "detectors": {
    "accessibility": {
      "risk_score": 45,
      "risk_level": "low",
      "issues_count": 8
    },
    "security": {
      "risk_score": 88,
      "risk_level": "high",
      "issues_count": 3
    },
    "ai_readiness": {
      "risk_score": 60,
      "risk_level": "medium",
      "issues_count": 5
    }
  }
}

Step 5: View in the dashboard

Navigate to your project in the Ariftly Dashboard to see the full findings breakdown, historical trends, and remediation recommendations.

What's next?

• Configure CI/CD integration — add Ariftly to your pipeline
• Set up webhooks — get notified when scans complete
• Understand risk scoring — learn how scores are calculated