Quickstart
Create an API key and send your first generation request.
GET /developer/v1/modelsGET /developer/v1/models/form-schemaPOST /developer/v1/generations- 1Create and securely store a Developer API key
- 2Resolve a catalog identity and submit the generation task
- 3Poll task status and refresh temporary output URLs
Authentication
Send Authorization: Bearer lpk_... from your server. Keys have query and generate scopes, are shown once, and must never appear in browser code.
Authorization: Bearer $VIDANCE_API_KEYIdempotency-Key: $IDEMPOTENCY_KEYgenerate · queryModel catalog
Resolve the model ID, capability, and schema version from the business model catalog instead of hardcoding provider assumptions.
GET /developer/v1/models?limit={limit}&offset={offset}GET /developer/v1/models/form-schemamodel_id · capability · schema_version · input_schemaGeneration tasks
Submit the complete catalog identity and schema-valid input with a stable Idempotency-Key header. The generate scope is required.
POST /developer/v1/generationsmodel_id · capability · schema_version · input202 · task_id · statusHow you're charged
Developer API charges use your prepaid USD wallet with hold-and-settle billing tied to each generation task.
POST /developer/v1/billing/estimateheld USD for the selected model1.A hold is placed first
When you submit a generation, Vidance places a hold for the estimated maximum charge in your API wallet.
2.The actual price is charged when the job succeeds
After the job completes successfully, the final metered amount is charged and any unused hold is released.
3.You never pay more than the hold
If metering finishes below the hold, only the result amount is charged and the remainder returns to available balance.
Example: a $6.00 hold with a $4.50 result charges $4.50 and returns the difference to available balance.
Status and results
Use the query scope to poll task status, list stable output indexes, and refresh temporary content URLs. Cancellation is not supported.
GET /developer/v1/generations?limit={limit}&offset={offset}GET /developer/v1/generations/{task_id}GET /developer/v1/generations/{task_id}/outputs/{output_index}/contenturl · url_expires_atErrors
Handle structured error codes and request identifiers without exposing sensitive request data.
{ code, message, request_id }400 Bad Request · 401 Unauthorized404 Not Found · 409 Conflict · 410 GoneIdempotency-Key