Skip to main content

​
Purpose

The Percify API lets you programmatically generate images, transform them into videos, synthesize voice audio, and retrieve published media assets. All endpoints follow predictable credit-based metering.

​
Base URL

https://api.percify.io/v1

​
Authentication

Use an API key in the Authorization header: 
Authorization: Bearer <API_KEY>
Keys are scoped per user account. Rotate periodically and never embed client-side.

​
Common Endpoints

ActionMethodPath
Generate ImagePOST/images/generate
Video From ImagePOST/videos/from-image
Clone VoicePOST/voices/clone
Generate AudioPOST/audio/generate
Avatar MetadataGET/avatars/
Credit BalanceGET/credits/balance

​
Response Pattern

Successful async generation requests return a processing object: 
{
  "id": "img_123",
  "status": "processing",
  "creditCost": 5,
  "createdAt": "2025-11-24T12:34:56Z"
}
Poll the status endpoint (same resource path) until status becomes completed.

​
Errors

StatusMeaningTypical Cause
400Bad requestMissing required field / invalid duration
401UnauthorizedMissing or bad API key
403ForbiddenBanned user or restricted asset
404Not foundInvalid resource id
429Rate limitedToo many requests in window
500Server errorInternal failure; retry later
For operations that could be retried (e.g., payment intent creation), include an Idempotency-Key header. Future endpoints may enforce uniqueness for safety.

​
Webhooks (Planned)

Upcoming event types:
  • avatar.generated
  • video.completed
  • audio.completed
  • credits.updated

​
OpenAPI Specification

The full schema resides in api-reference/openapi.json. Use it to generate client SDKs or validate requests.

​
Next Steps

  • Review authentication details at [/percify/api-auth]
  • Explore endpoint examples in the API Reference tab
  • Learn credit cost formulas at [/percify/credits]
Need a new endpoint? Request via support with use case details.