API Introduction

The AIPTx API provides programmatic access to all platform features, enabling you to integrate AI-powered penetration testing into your workflows.

Base URL

All API requests should be made to:

https://api.aiptx.io/v1

Authentication

The AIPTx API uses Bearer token authentication. Include your API key in the Authorization header:

curl -X GET "https://api.aiptx.io/v1/scans" \
  -H "Authorization: Bearer YOUR_API_KEY"

Getting Your API Key

Log in to the AIPTx Dashboard
Navigate to Settings → API Keys
Click Generate New Key
Copy and securely store your key

API keys provide full access to your account. Never share them or commit them to version control. Use environment variables instead.

Request Format

Headers

All requests should include:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json

Request Body

POST and PUT requests accept JSON bodies:

{
  "target": "https://example.com",
  "mode": "standard",
  "options": {
    "authentication": {
      "type": "bearer",
      "token": "your_app_token"
    }
  }
}

Response Format

All responses are returned in JSON format:

{
  "success": true,
  "data": {
    "id": "scan_abc123",
    "status": "running",
    "created_at": "2024-01-15T10:30:00Z"
  },
  "meta": {
    "request_id": "req_xyz789"
  }
}

Error Responses

Errors follow a consistent format:

{
  "success": false,
  "error": {
    "code": "INVALID_TARGET",
    "message": "The provided target URL is not accessible",
    "details": {
      "target": "https://invalid.example.com",
      "reason": "DNS resolution failed"
    }
  },
  "meta": {
    "request_id": "req_xyz789"
  }
}

HTTP Status Codes

Code	Description
`200`	Success
`201`	Resource created
`400`	Bad request - Invalid parameters
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - Insufficient permissions
`404`	Not found - Resource doesn’t exist
`429`	Rate limited - Too many requests
`500`	Server error - Something went wrong

Rate Limits

API requests are rate limited based on your plan:

Plan	Requests/minute	Concurrent Scans
Starter	60	1
Professional	120	4
Business	300	10
Enterprise	Custom	Custom

Rate limit headers are included in every response:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1705312800

Pagination

List endpoints support pagination:

GET /v1/scans?page=1&limit=20

Paginated responses include metadata:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 156,
    "total_pages": 8
  }
}

Versioning

The API is versioned via the URL path (/v1/). We maintain backward compatibility within major versions. Breaking changes will be introduced in new major versions with advance notice.

SDKs

Official SDKs are available for popular languages:

Python SDK

pip install aiptx

Node.js SDK

npm install @aiptx/sdk

Go SDK

go get github.com/aiptx/go-sdk

Ruby SDK

gem install aiptx

Quick Example

Here’s a complete example of starting a scan and retrieving results:

import aiptx

# Initialize client
client = aiptx.Client(api_key="YOUR_API_KEY")

# Start a scan
scan = client.scans.create(
    target="https://example.com",
    mode="standard"
)

print(f"Scan started: {scan.id}")

# Wait for completion
scan.wait_for_completion()

# Get findings
findings = client.findings.list(scan_id=scan.id)

for finding in findings:
    print(f"[{finding.severity}] {finding.title}")

​API Introduction

​Base URL

​Authentication

​Getting Your API Key

​Request Format

​Headers

​Request Body

​Response Format

​Error Responses

​HTTP Status Codes

​Rate Limits

​Pagination

​Versioning

​SDKs

Python SDK

Node.js SDK

Go SDK

Ruby SDK

​Quick Example

API Introduction

Base URL

Authentication

Getting Your API Key

Request Format

Headers

Request Body

Response Format

Error Responses

HTTP Status Codes

Rate Limits

Pagination

Versioning

SDKs

Quick Example