API Reference

Comprehensive API Docs for Intelligent Video

Use NeoQuicksy APIs to generate, analyze, transform, and automate video workflows through secure and scalable endpoints.

Base URLhttps://api.neoquicksy.com/v1

Authentication

Secure API access.

All API requests require authentication using an API key. Pass your key in the Authorization header on every request.

Request Header
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Example Request
GET /v1/account
Authorization: Bearer YOUR_API_KEY
Example Response
{
  "success": true,
  "account_id": "acc_123456",
  "plan": "Professional"
}

Video Generation API

Generate videos from text or images.

Create Video

POST/v1/video/generate
Request
{
  "prompt": "A futuristic smart city at night with flying vehicles",
  "duration": 10,
  "resolution": "1080p"
}
Response
{
  "success": true,
  "job_id": "vid_789123",
  "status": "processing"
}

Get Video Status

GET/v1/video/status/{job_id}
Response
{
  "job_id": "vid_789123",
  "status": "completed",
  "progress": 100
}

Retrieve Generated Video

GET/v1/video/{job_id}
Response
{
  "video_url": "https://cdn.neoquicksy.com/videos/output.mp4",
  "duration": 10
}

Video Intelligence API

Analyze and understand video content.

Analyze Video

POST/v1/intelligence/analyze
Request
{
  "video_url": "https://example.com/video.mp4"
}
Response
{
  "success": true,
  "analysis_id": "ana_456789",
  "status": "processing"
}

Get Analysis Results

GET/v1/intelligence/results/{analysis_id}
Response
{
  "scenes": 12,
  "objects_detected": 54,
  "summary": "The video contains urban traffic and pedestrian activity."
}

Video Transformation API

Enhance and modify video content.

Enhance Video

POST/v1/transform/enhance
Request
{
  "video_url": "https://example.com/video.mp4",
  "enhancement": "upscale"
}
Response
{
  "success": true,
  "job_id": "enh_123456"
}

Generate Subtitles

POST/v1/transform/subtitles
Request
{
  "video_url": "https://example.com/video.mp4",
  "language": "en"
}
Response
{
  "subtitle_url": "https://cdn.neoquicksy.com/subtitles/file.srt"
}

Workflow Automation API

Automate video operations.

Create Workflow

POST/v1/workflows
Request
{
  "workflow_name": "Marketing Video Pipeline",
  "steps": [
    "generate_video",
    "enhance_video",
    "publish"
  ]
}
Response
{
  "workflow_id": "wf_987654",
  "status": "created"
}

Trigger Workflow

POST/v1/workflows/{workflow_id}/run
Response
{
  "execution_id": "exec_112233",
  "status": "running"
}

Account API

Manage account information.

Get Account Details

GET/v1/account
Response
{
  "account_id": "acc_123456",
  "email": "user@example.com",
  "plan": "Business"
}

Usage Statistics

GET/v1/account/usage
Response
{
  "videos_generated": 145,
  "api_requests": 12850,
  "storage_used": "18GB"
}

Webhooks

Receive real-time events.

Supported Events

  • video.generated
  • video.failed
  • analysis.completed
  • workflow.completed
  • workflow.failed

Example Payload

POST · your endpoint
{
  "event": "video.generated",
  "job_id": "vid_789123",
  "status": "completed"
}

Error Codes

Standard HTTP status codes.

CodeDescription
400Bad Request
401Unauthorized
403Forbidden
404Resource Not Found
429Rate Limit Exceeded
500Internal Server Error

Rate Limits

Limits by plan tier.

Starter

100

requests / day

Professional

10,000

requests / month

Business

100,000

requests / month

Enterprise

Custom

limits

SDKs

Official client libraries.

JSJavaScript
PyPython
NodeNode.js
PHPPHP
JvJava

Support

Need help?

Get Started

Start Building with NeoQuicksy APIs

Integrate intelligent video generation, analysis, transformation, and automation into your applications.