How This Helps
Secure API access is essential for integrating Visual Layer with your pipelines or external tools. This guide shows how to retrieve your API credentials and use them to generate a JWT for authenticated requests.
Step 1: Get Your API Key and Secret
To obtain your API key and secret:1
Log in to Visual Layer
Go to https://app.visual-layer.com and sign in with your user account.
2
Visit the API Credentials Page
Navigate to https://app.visual-layer.com/api/v1/api_credentials while logged in.
You must be authenticated in the browser for this to work. The request depends on your active browser session.
Request
Example Response
curl
:
Step 2: Generate JWT Token for Authentication
Use your API key and secret to generate a JWT token, which is required for authenticated API requests.JWT Token Authentication
JWTs must be included in the
These tokens are short-lived and should be regenerated periodically.
Authorization
header as a Bearer token
type on every request.These tokens are short-lived and should be regenerated periodically.
Example Python Code
⚠️ Please make sure you have PyJWT
installed. If not, install it using:
JWT tokens expire quickly by design. For best security and performance, regenerate tokens periodically based on your security requirements.