Documentation

API Reference

Authentication

To use the PreInspect API, you'll need to authenticate your requests using an API key. You can obtain your API key from your dashboard after signing up for a paid plan.

Authorization: Bearer YOUR_API_KEY

Endpoints

Image Analysis

POST /api/analyse-image

Upload an image for analysis. Returns detailed structural assessment and detected issues.

SDK Documentation

Installation

npm install PreInspect-sdk

Quick Start

Import and initialize the PreInspect SDK in your application:

import { PreInspect } from 'preinspect-sdk';

const PreInspect = new PreInspect('YOUR_API_KEY');

// Analyze an image
const result = await PreInspect.analyzeImage(imageFile);

Integration Guide

Follow these steps to integrate PreInspect into your application:

  1. Sign up for a PreInspect account and obtain your API key
  2. Install the PreInspect SDK using npm or yarn
  3. Initialize the SDK with your API key
  4. Start analyzing images using our API endpoints
  5. Handle the analysis results in your application