Comprehensive Guide to Vidulk API Documentation

Estimated reading time: 8 minutes

Key Takeaways

• Seamless Integration: Early familiarization with Vidulk API documentation ensures smooth authentication and endpoint usage.
• Efficiency: Understanding response schemas and error codes reduces debugging time and integration errors.
• Security: Proper key management and HTTPS usage safeguard your workflows and data.
• Best Practices: Hands-on testing, batch-processing, and cost management accelerate production-ready setups.
• Comprehensive Coverage: From video clipping to chat-story generation, the API supports diverse automation scenarios.

Table of Contents

• Overview of Vidulk API Documentation
• Structure and Components of the Documentation
• Detailed Walkthrough of API Endpoints
• Authentication and Security
• Best Practices
• FAQ

Overview of Vidulk API Documentation

Vidulk’s RESTful API powers AI-driven video workflows, enabling developers to automate:

• Short-form social clips via video clipping and highlight detection
• Fake chat video generation for marketing or storytelling
• On-device upscaling and noise reduction with GPU/NPU acceleration
• Batch processing for podcasts and faceless story production

Use cases include social media teasers, podcast snippets, and dynamic chat-based videos. Early mastery of the documentation reduces errors and speeds up your integration.

Structure and Components of the Documentation

The Vidulk API follows a clear RESTful convention, organized into:

1. Endpoints
   • Base URL: https://www.vidu.io/api/v1
   • Resources: /me, /jobs, /jobs/{id}
2. Parameters
   • Query & path parameters (e.g., job_id)
   • JSON body fields (e.g., project_id, inputs)
3. Authentication
   • API keys via the Authorization header
4. Response Schemas
   • Structured JSON for data and asset URLs
5. Error Codes
   • Standard HTTP (400, 401, 404, 500)
   • Application-specific errors in the response body

Primary sections include key generation (Settings > API), user info (GET /api/v1/me), job creation (POST /api/v1/jobs), job status (GET /api/v1/jobs/{id}), and asset access.

Detailed Walkthrough of API Endpoints

Include Authorization: Bearer {your_api_key} in every request header.

1. GET /api/v1/me

Purpose: Retrieve authenticated user and workspace details.

curl -X GET "https://www.vidu.io/api/v1/me" -H "Authorization: Bearer {token}"

Response fields: id, email, workspaces, plan

2. POST /api/v1/jobs

Purpose: Submit a new video generation job.

curl -X POST "https://www.vidu.io/api/v1/jobs" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}" \
  -d '{ "project_id": 26896, "inputs": { "website_1_url": "https://example.com/page1" } }'

Common errors include 400 Bad Request, 401 Unauthorized, and 404 Not Found.

3. GET /api/v1/jobs/{id}

Purpose: Fetch job status and outputs. Poll until status is complete or error.

Sample complete response:

{
  "id": 7654321,
  "status": "complete",
  "outputs": {
    "assets": {
      "poster": {"url": "https://files.vidu.io/.../poster.mp4"},
      "thumbnail": {"url": "https://files.vidu.io/.../thumbnail.gif"},
      "video": {"url": "https://files.vidu.io/.../video.mp4"}
    }
  },
  "view_url": "https://videos.yourdomain.com/watch/bzMbzRxFUoSd"
}

Implement exponential backoff on errors and inspect the message field for details.

Authentication and Security

Generating API Keys

• Navigate to Settings > API in your Vidulk dashboard.
• Enroll in the beta program if required.
• Generate and name keys for easy management.

Header Requirements

• Add Authorization: Bearer {token} to every request.
• Use HTTPS to encrypt data in transit.

Security Best Practices

• Store keys in environment variables or secure vaults.
• Rotate keys periodically and revoke unused tokens.
• Avoid embedding keys in client-side code.

Best Practices

• Scan-First Onboarding: Read summaries before exploring examples.
• Hands-On Testing: Use cURL or REST clients in your terminal.
• Batch-Processing: Group jobs in scripts for efficiency.
• Avoid Pitfalls: Always include the API key and poll for job status.
• Cost Management: Test on the free tier, then review pricing models.

FAQ

How do I set up API keys?

Go to Settings > API, enroll in the beta if needed, generate keys, and include them in the Authorization header.

What if a job fails or returns “error”?

Poll GET /api/v1/jobs/{id}, check the message field for details, verify your inputs, and retry with exponential backoff.

Can I process videos offline?

On-device enhancements work offline, but full job submissions require internet connectivity.