Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Authenta API Overview

Authenta provides a secure, scalable API that allows customers to integrate deepfake-detection capabilities directly into their own applications and services.
With API access, you can programmatically upload media, check analysis results, and manage previously processed items using authenticated API calls.

The Authenta API is designed for organizations that require automated or large-scale media validation workflows beyond what is available in the Authenta web console.

Why Use the Authenta API?

Authenta’s API enables you to:

  • Automate deepfake detection pipelines in your internal systems
  • Upload media programmatically for evaluation
  • Fetch results and metadata without using the UI
  • Integrate trust & safety checks directly into your product
  • Manage media lifecycle (upload, fetch, delete)

The API uses the same detection engine and produces the same results as the Authenta platform—just accessible via secure endpoints.

Quick Start

Getting started with the API is simple:

  1. Navigate to Settings → API Keys in your Authenta Console
  2. Click Create API Key
  3. Configure your key name and permissions
  4. Copy your API key immediately and store it securely
  5. Start making authenticated API calls

Authentication Model

All API calls require one header:

Authorization: Bearer api__xxxxxxxx...

Your API key uniquely identifies and authenticates your requests. The API key is shown only once, so make sure to store it securely.

Authenta uses a simple bearer token authentication system suitable for on-prem and SaaS environments.

API Operations & Request Types

Authenta internally classifies requests into two types:

Query Requests

  • Correspond to GET routes
  • Used for reading data

Examples:

  • Fetch all media
  • Fetch a media item by ID

Mutation Requests

  • Correspond to POST, PUT, DELETE routes
  • Used for modifying data

Examples:

  • Upload media
  • Delete media

Credits System

Authenta uses a credit-based billing system for all media operations.

  • When you upload or process media via the API, credits are consumed
  • Credit deduction happens exactly the same way as when using the Authenta UI
  • Query-only endpoints (such as fetching metadata) do not consume credits

Credits and quotas operate independently:

ResourcePurpose
CreditsCharged for media processing
QuotasLimit the number of API calls (query/mutation)

A user can have available API quota but insufficient credits required for processing.

TypeScript API Types

Authenta ships first-class TypeScript types describing all API request and response structures. These types are included in the api-types.d.ts file and define:

  • Media object shapes
  • Upload request body schema
  • Detection metadata
  • Error responses
  • Pagination types
  • API route definitions

This ensures type-safe usage for integrations built in TypeScript or Node.js. (If needed, you can import these types directly into your application.)

Supported API Endpoints

The current set of public API routes includes:

  • GET /api/v1/jobs — List All Jobs (Query)
  • GET /api/v1/jobs/{id} — Get Job Details (Query)
  • POST /api/v1/jobs — Create Job & Upload Media (Mutation)
  • POST /api/v1/jobs/{id}/finalize — Finalize Job & Queue Processing (Mutation)
  • POST /api/v1/jobs/{id}/cancel — Cancel Job (Mutation)
  • DELETE /api/v1/jobs/{id} — Delete Job (Mutation)

Full details are available in Jobs API References

Next Steps

To begin integrating the API:

  1. Continue to Requesting API Access
  2. Then Generate API Keys
  3. Finally, follow Using the API

Authenta’s API enables powerful automated trust-analysis workflows, and this section of the documentation will guide you through each step of the integration.