Authentication & Essentials
In this section, we'll discuss how to securely authorize your requests, handle potential errors, and manage credits for ShortGenius services.
Authentication (Bearer Token)
All ShortGenius endpoints require a valid bearer token. If you haven't already retrieved a token from your ShortGenius dashboard, follow the sign-up process mentioned in our Getting Started Quickstart.
Using cURL
How to include your token:
Authorization: Bearer YOUR_API_TOKEN
Example request:
curl --request GET \
--url "https://shortgenius.com/api/v1/health" \
--header "Authorization: Bearer YOUR_API_TOKEN"
Using SDKs
If you're using one of our official SDKs, authentication is even simpler:
import { ShortGenius } from 'shortgenius'
const client = new ShortGenius({
bearerAuth: 'YOUR_API_TOKEN'
})
// The SDK automatically includes the bearer token in all requests
const status = await client.status.check()
You can also use environment variables:
// SDK will automatically use SHORTGENIUS_BEARER_AUTH env variable
const client = new ShortGenius({
bearerAuth: process.env.SHORTGENIUS_BEARER_AUTH
})
Handling Errors
ShortGenius will return standard HTTP status codes and JSON-encoded error messages when something goes wrong. Below are some common error types:
400
Bad Request
{"message": "Invalid request"}
401
Unauthorized
{"message": "Unauthorized"}
404
Not Found
{"message": "Not found"}
429
Too Many Requests
{"message": "Rate limit exceeded"}
500
Internal Server Error
{"message": "Something went wrong"}
Example of a 400 Response:
{
"message": "Invalid request"
}
SDK Error Handling
The SDKs provide typed error handling:
import { ShortGenius, APIError } from 'shortgenius'
const client = new ShortGenius({ bearerAuth: 'YOUR_API_TOKEN' })
const video = await client.getVideo('invalid-id')
Always inspect the returned JSON for more details on why a request failed.
Rate Limits & Credits
ShortGenius enforces usage limits via a credit-based system. Each time you generate a video, image, or audio file, credits are deducted from your account.
Types of credits include:
credits
– General-purpose for many actionsanimated_video_credits
– Special tier for certain AI animationsimage_credits
– Used specifically for image generationhigh_quality_video_credits
– For higher resolution or advanced video rendering
Checking Your Credit Balance
Use the GET /credits
endpoint to see how many credits remain:
const usage = await client.getUsage()
console.log('Credit Balance:')
console.log(` General credits: ${usage.balance.credits}`)
console.log(` Image credits: ${usage.balance.image_credits}`)
console.log(` Animated video credits: ${usage.balance.animated_video_credits}`)
console.log(` High quality video credits: ${usage.balance.high_quality_video_credits}`)
Next Steps You're now ready to dig into ShortGenius's core functionality. Let's move on to Video Generation to learn how to create short AI-driven clips from scratch.
Last updated