Skip to main content

Authentication

All requests to the Valossa Core API require a valid API key. This page explains how to obtain, use, and secure your API keys.

Obtaining Your API Key​

Free trial available

No subscription yet? Sign up for a Transcribe Pro Vision MAX free trial at valossa.com/transcribe-video-to-text-ai — no sales call required. Your API key will be available in Portal immediately after registration.

  1. Log in to Valossa Portal.
  2. Navigate to My Account > Subscriptions and API Keys.
  3. Your API key is displayed on this page. Copy it and store it securely.

Each API key is bound to a specific Valossa AI subscription. The API key you use in a new_job request determines which set of AI features are applied to that analysis job. See Subscriptions & Feature Access for details on plans, features, and multi-user setup.

Passing the API Key​

The method for passing your API key depends on the HTTP method of the endpoint:

POST Requests (new_job, cancel_job, delete_job)​

Include the api_key field in the JSON request body:

{
  "api_key": "YOUR_API_KEY",
  "media": {
    "video": {
      "url": "https://example.com/video.mp4"
    }
  }
}

GET Requests (job_status, job_results, list_jobs)​

Pass the api_key as a query parameter in the URL:

https://api-eu.valossa.com/core/1.0/job_status?api_key=YOUR_API_KEY&job_id=JOB_ID

Security Best Practices​

Follow these guidelines to protect your API key:

  • Always use HTTPS. The API enforces HTTPS for all requests. Unencrypted HTTP is not supported.
  • Never expose your API key in client-side code. If you are building a web application, proxy API calls through your backend server.
  • Do not commit API keys to version control. Use environment variables or a secrets manager instead.
  • Rotate keys if compromised. Contact Valossa support immediately if you suspect your API key has been exposed.
  • Use separate keys for separate applications. Request additional API keys from Valossa support if you run multiple applications, so you can revoke access to one without affecting others.
  • Restrict access per user. On enterprise plans, use the Manage Users feature in Valossa Portal to limit which users have access to which API keys. See Subscriptions & Feature Access for multi-user details.

Example: Environment Variable Usage​

Store your API key in an environment variable and reference it in your code:

Bash​

export VALOSSA_API_KEY="YOUR_API_KEY"

curl -X POST \
  -H "Content-Type: application/json" \
  -d "{\"api_key\": \"$VALOSSA_API_KEY\", \"media\": {\"video\": {\"url\": \"https://example.com/video.mp4\"}}}" \
  https://api-eu.valossa.com/core/1.0/new_job

Python​

import os
import requests

api_key = os.environ["VALOSSA_API_KEY"]

response = requests.post(
    "https://api-eu.valossa.com/core/1.0/new_job",
    json={
        "api_key": api_key,
        "media": {
            "video": {
                "url": "https://example.com/video.mp4"
            }
        }
    }
)

JavaScript (Node.js)​

const apiKey = process.env.VALOSSA_API_KEY;

const response = await fetch("https://api-eu.valossa.com/core/1.0/new_job", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    api_key: apiKey,
    media: {
      video: {
        url: "https://example.com/video.mp4"
      }
    }
  })
});