Fixless Audits

import requests

# Replace with your actual API key
API_KEY = 'your_api_key_here'

# Set up the headers for the request
headers = {
    "accept": "application/json"  # Specify that we want the response in JSON format
}

# Create an audit 
body = {...} # FixlessAuditCreate
url = "https://api.scale.com/v1/audits"
response = requests.put(url, headers=headers, auth=(API_KEY, ''), json=body) # 201 response FixlessAudit
print(response.text)

# Get audits
url = "https://api.scale.com/v1/audits/?task_id=xxx&id=yyy" # provide task id or audit id
response = requests.get(url, headers=headers, auth=(API_KEY, '')) # 200 response FixlessAudit[]
print(response.text)

FixlessAuditCreate {
  type: 'fixless';
  result: 'accepted' | 'rejected';
  task_id: string;
  comments?: string;
  target_response_url: string; // from task.response.annotations.url (task.response.ortho for LidarTopdown tasks)
  feedback_items?: FeedbackItemCreate[];
  metadata?: { [key: string]: any };
}

FeedbackItemCreate {
  type: 'comment' | 'error' | 'flag' | 'confirmation';
  scope: FeedbackItemScope; 
  category:
    | 'attribute'
    | 'extraneous'
    | 'geometry'
    | 'label'
    | 'missing'
    | 'position';
  severity?: 'mild' | 'standard' | 'severe';
  description?: string;
  metadata?: { [key: string]: any };
}

FeedbackItemScope =
  | FeedbackItemScopeAnnotation
  | FeedbackItemScopePolygon
  | FeedbackItemScopePoint
  | FeedbackItemScopeScene;

// extraneous, geometry, label, position errors should use this scope
// most attribute errors should use this scope. The exception is scene attributes
FeedbackItemScopeAnnotation = {
  type: 'annotation';
  annotation_id: string; 
  sensor_id?: string | number; // defaults to the scene's primary sensor (typically the first lidar). Typically used to identify a specific camera for 2D projections
  attribute?: string; // attribute name. defined iff scoped on an annotation attribute
  interval: FeedbackItemTimestampRange;
}

// Only for missing annotation errors
FeedbackItemScopePolygon {
  type: 'polygon';
  vertices: [[x0, y0], [x1, y1], [x2, y2], ...];
  missing_annotation_type: AnnotationType; // type of missing annotation. see enum definition below
  stationary: boolean; // only applies for cuboids and indicates if cuboid is stationary or dynamic. This is important for quality score calculations
  missing_annotation_class?: string; // label name for missing annotation
  sensor_id?: string; // indicate camera sensor id iff vertices are in camera coordinates. Otherwise, we assume 3d coordinates (z-value assumed to be 0)
  interval: FeedbackItemTimestampRange;
}

// Only for missing annotation errors
FeedbackItemScopePoint {
  type: 'point';
  coordinates: [x, y];
  missing_annotation_type: AnnotationType; // type of missing annotation. see enum definition below
  stationary: boolean; // only applies for cuboids and indicates if cuboid is stationary or dynamic. This is important for quality score calculations
  missing_annotation_class?: string; // label name for missing annotation
  sensor_id?: string; // indicate camera sensor id iff coordinates are in camera coordinates. Otherwise, we assume 3d coordinates (z-value assumed to be 0)
  interval: FeedbackItemTimestampRange;
}

// only used for scene attribute errors
FeedbackItemScopeScene {
  type: 'scene';
  attribute?: string; // scene attribute name
  interval: FeedbackItemTimestampRange;
}

FeedbackItemInterval = {
  type: 'frame_range';
  start: number; // frame index
  end: number; // frame index
};

// missing annotation types for FeedbackItemScopePoint and FeedbackItemScopePolygon 
AnnotationType = 
  // 3D - task types: sensorFusion, multiStage
  'cuboid' |
  
  // 2D - task types: videoAnnotation, multiStage
  'box_2d' |
  'polygon_2d' |
  'polyline_2d' |
  'point_2d' |
  'event'

  // LTD - task types: lidarTopdown, multiStage
  'polygon_topdown' |
  'polyline' |
  'point_topdown';

FixlessAudit {
  id: string;
  srn: 'srn:scale:avcv:audit:{{id}}' // SRNs can be used in place of id on endpoints
  type: 'fixless';
  result: 'accepted' | 'rejected';
  task_id: string;
  comments?: string;
  target_response: { url: string };
  feedback_items?: FeedbackItem[];
  metadata?: { [key: string]: any };
  active: boolean; // whether this is the latest audit
  source: 'api' | 'lidarlite' | 'classic';
  created_by: string;
  created_at: iso_date_string;
  updated_at: iso_date_string;
}

import requests
from requests.auth import HTTPBasicAuth

headers = {"Accept": "application/json"}
auth = HTTPBasicAuth('{{ApiKey}}', '') # No password

response = requests.request(
    "PUT",
    "https://api.scale.com/v1/audits",
    json={
        "type": "fixless",
        "result": "rejected",
        "task_id": "task_id_here",
        "comments": "test reject comment",
        "target_response_url": "value from task.response.annotations.url",
        "feedback_items": [
            {
                "type": "comment",
                "scope": {
                    "type": "annotation",
                    "annotation_id": "abc123",
                    "sensor_id": "789xyz",
                    "interval": {
                        "type": "frame_range",
                        "start": 0,
                        "end": 10,
                    },
                },
                "severity": "mild",
                "description": "feedback 1",
            },
            {
                "type": "confirmation",
                "scope": {
                    "type": "scene",
                    "attribute": "weather",
                    "interval": {
                        "type": "frame_range",
                        "start": 0,
                        "end": 100,
                    },
                },
                "description": "feedback 2",
            },
        ],
        "metadata": { "test": True },
    },
    headers=headers,
    auth=auth,
)

response.status_code # 201

response.text
{
  "id": "6594cfca95644b72685e76e1",
  "type": "fixless",
  "task_id": "task_id_here",
  "task_type": "sensorfusion",
  "result": "rejected",
  "target_response": {
    "url": "value from task.response.annotations.url"
  },
  "comments": "test reject comment",
  "feedback_items": [
    {
      "id": "6594cfca95644b72685e76e5",
      "type": "comment",
      "state": "open",
      "scope": {
        "type": "annotation",
        "annotation_id": "abc123",
        "sensor_id": "789xyz",
        "interval": { "type": "frame_range", "start": 0, "end": 10 }
      },
      "severity": "mild",
      "description": "feedback 1",
      "updated_at": "2024-01-03T03:08:58.200Z",
      "updated_by": "user_id_123456"
    },
    {
      "id": "6594cfca95644b72685e76e6",
      "type": "confirmation",
      "state": "open",
      "scope": {
        "type": "scene",
        "attribute": "weather",
        "interval": { "type": "frame_range", "start": 0, "end": 100 }
      },
      "description": "feedback 2",
      "updated_at": "2024-01-03T03:08:58.201Z",
      "updated_by": "user_id_123456"
    }
  ],
  "metadata": { "test": true },
  "active": false,
  "source": "api",
  "created_by": "user_id_123456",
  "created_at": "2024-01-03T03:08:58.162Z",
  "updated_at": "2024-01-03T03:09:42.943Z"
}