Simple & Secure API

Integrate BeepVault's AI-powered media redaction into your applications with our RESTful API.

API Overview

BeepVault provides a simple RESTful API that allows you to integrate our AI-powered media redaction capabilities into your applications. Our API is secured with JWT authentication and follows REST best practices.

Secure Authentication

JWT-based authentication ensures secure access to your API endpoints. Get your API key from the dashboard.

RESTful Endpoints

Simple and intuitive RESTful endpoints for redaction, status checking, and file downloads.

Comprehensive Documentation

Detailed API documentation with examples, SDKs, and integration guides for all major platforms.

SDK Support

Official SDKs for popular programming languages to simplify integration with your applications.

Authentication

All API requests must be authenticated using a JWT token. You can obtain your API key from the dashboard.

// Example: Obtaining a JWT token
curl -X POST https://api.beepvault.com/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "your_api_key",
    "api_secret": "your_api_secret"
  }'

Include the JWT token in the Authorization header of all API requests:

Authorization: Bearer your_jwt_token

API Endpoints

POST/api/v1/redact

Redact sensitive information from media files

Parameters:

  • file: Media file (audio, video, image)
  • options: Redaction options (optional)
GET/api/v1/status/{job_id}

Check the status of a redaction job

Parameters:

  • job_id: ID of the redaction job
GET/api/v1/download/{job_id}

Download the redacted media file

Parameters:

  • job_id: ID of the redaction job

SDKs & Libraries

Official SDKs for popular programming languages

Python

Python

pip install beepvault

Official Python client library with async support and comprehensive documentation.

Node.js

Node.js

npm install @beepvault/sdk

TypeScript-based SDK with full type support and modern JavaScript features.

Java

Java

implementation 'com.beepvault:sdk:1.0.0'

Enterprise-grade Java SDK with Spring Boot integration and comprehensive examples.

.NET

.NET

dotnet add package BeepVault.SDK

Full-featured .NET SDK with async/await support and dependency injection.

Go

Go

go get github.com/beepvault/sdk

High-performance Go SDK with context support and goroutine safety.

Ruby

Ruby

gem install beepvault-sdk

Elegant Ruby SDK with Rails integration and comprehensive test coverage.

Ready to Get Started?

Sign up for a free API key and start integrating BeepVault into your applications today.

Get Your API Key