@celluloid/vision-api

A TypeScript client library for the Vision API, generated from the official OpenAPI specification. This package provides a fully type-safe fetch client for video analysis and object detection.

Installation

pnpm add @celluloid/vision-api

Or with npm:

npm install @celluloid/vision-api

Usage

Basic Example - Starting Video Analysis

import { createClient } from '@celluloid/vision-api/client/client';
import { startDetectionAnalysePost } from '@celluloid/vision-api/client';

const client = createClient({
  baseUrl: 'https://vision.celluloid.me',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
  },
});

const response = await startDetectionAnalysePost({
  client,
  body: {
    project_id: 'your-project-id',
    video_url: 'https://example.com/video.mp4',
    similarity_threshold: 0.5,
  },
});

console.log(response.data); // { job_id, status, queue_position, message, callback_url }

Using the Default Client Instance

You can also use the pre-configured default client instance:

import { client } from '@celluloid/vision-api/client/client.gen';
import { startDetectionAnalysePost } from '@celluloid/vision-api/client';

// Configure the default client
client.setConfig({
  baseUrl: 'https://vision.celluloid.me',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
  },
});

const response = await startDetectionAnalysePost({
  client,
  body: {
    project_id: 'your-project-id',
    video_url: 'https://example.com/video.mp4',
  },
});

Checking Job Status

import { getJobStatusStatusJobIdGet } from '@celluloid/vision-api/client';

const status = await getJobStatusStatusJobIdGet({
  client,
  path: {
    job_id: 'your-job-id',
  },
});

console.log(status.data); // { status, progress, ... }

Getting Job Results

import { getJobResultsResultsJobIdGet } from '@celluloid/vision-api/client';

const results = await getJobResultsResultsJobIdGet({
  client,
  path: {
    job_id: 'your-job-id',
  },
});

console.log(results.data); // { version, metadata, frames, ... }

Health Check

import { healthCheckHealthGet } from '@celluloid/vision-api/client';

const health = await healthCheckHealthGet({ client });
console.log(health.data); // { status: 'ok' }

Custom Configuration

import { createClient } from '@celluloid/vision-api/client';

const client = createClient({
  baseUrl: 'https://vision.celluloid.me',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'User-Agent': 'MyApp/1.0',
  },
  fetch: customFetch,
});

client.setConfig({
  baseUrl: 'https://another-instance.com',
});

API Reference

The client is generated from the Vision API OpenAPI specification. All API endpoints are available through the SDK functions exported from @celluloid/peertube-api/client.

Available Endpoints

• healthCheckHealthGet - Health check endpoint
• startDetectionAnalysePost - Start video analysis (requires API key)
• getJobStatusStatusJobIdGet - Get the status of a detection job
• getJobResultsResultsJobIdGet - Get the results of a completed detection job

Development

Prerequisites

• Node.js (v18 or higher)
• pnpm (v9 or higher)

Setup

1. Clone the repository
2. Install dependencies:

pnpm install

Generate Client

pnpm run generate

Build

pnpm run build

Type Checking

pnpm run typecheck

License

MIT