PixlData API Documentation

Professional data labeling API. Send images, get annotations back.

Quick Setup

Your API Key:

1. Test Authentication

curl -X GET "https://your-domain.com/api/v1/usage" \
  -H "Authorization: Bearer px_your_api_key_here"

2. Create Project

curl -X POST "https://your-domain.com/api/v1/projects/paygo" \
  -H "Authorization: Bearer px_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Project",
    "description": "Product detection",
    "annotation_breakdown": {
      "bounding_box": 10,
      "classification": 5
    },
    "priority": "normal",
    "instructions": "Draw boxes around all products"
  }'
→ Returns project ID in response.data.project.id

3. Upload Files

curl -X POST "https://your-domain.com/api/v1/projects/PROJECT_ID/files" \
  -H "Authorization: Bearer px_your_api_key_here" \
  -F "files=@image1.jpg" \
  -F "files=@image2.jpg" \
  -F "files=@image3.jpg"

4. Check Status

curl -X GET "https://your-domain.com/api/v1/projects/PROJECT_ID" \
  -H "Authorization: Bearer px_your_api_key_here"
→ Status will be "pending" → "processing" → "completed"

5. Download Results

Individual Files:
curl -X GET "https://your-domain.com/api/v1/projects/PROJECT_ID/results" \
  -H "Authorization: Bearer px_your_api_key_here"
ZIP Archive:
curl -X GET "https://your-domain.com/api/v1/projects/PROJECT_ID/results/archive" \
  -H "Authorization: Bearer px_your_api_key_here"

Pricing

$0.035
Bounding Box
$0.015
Classification
$0.080
Polygon
$0.025
Keypoint
$0.120
Segmentation
Quote
Custom

Response Format

{
  "success": true,
  "data": {
    "project": {
      "id": "proj_abc123",
      "status": "completed",
      "pricing": {
        "total_cost": 0.26
      }
    }
  }
}

All Endpoints

GET /api/v1/usage - Check authentication & usage
POST /api/v1/projects/paygo - Create pay-as-you-go project
POST /api/v1/projects/quote - Request custom quote
GET /api/v1/projects/{id} - Get project status
PATCH /api/v1/projects/{id} - Update project
POST /api/v1/projects/{id}/files - Upload files
GET /api/v1/projects/{id}/results - List completed files
GET /api/v1/projects/{id}/files/{fileId}/download - Download file
GET /api/v1/projects/{id}/results/archive - Download ZIP