Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/rushilkukreja/hoohacks/llms.txt

Use this file to discover all available pages before exploring further.

Three endpoints let you verify that Splyce is running and that its external dependencies are configured correctly. None of these endpoints require authentication or a request body.

​
GET /api/health

Returns the overall service status and whether the AI providers are configured. 
curl http://127.0.0.1:8000/api/health
Response 
{
  "status": "ok",
  "service": "splyce-ad-personalization",
  "prompt_api": "product-prompt-v2-no-standard-ad",
  "gemini_configured": true,
  "elevenlabs_configured": true
}
​
status
string
Always "ok" when the server is reachable.
​
service
string
Static service identifier string.
​
prompt_api
string
Active prompt API version label.
​
gemini_configured
boolean
true if GEMINI_API_KEY is set in the environment.
​
elevenlabs_configured
boolean
true if ELEVENLABS_API_KEY is set in the environment.

​
GET /api/version

Returns routing information and a summary of available endpoints. 
curl http://127.0.0.1:8000/api/version
Response 
{
  "prompt_api": "product-prompt-v2-no-standard-ad",
  "standard_ad": "optional-ignored",
  "identify_endpoints": "/api/identify-product or /api/ai/identify-product",
  "video_placement": "/api/analyze-video (multipart: video + product_name)",
  "video_generate": "/api/generate-ad-video (multipart: video_id + analysis JSON + product_name)"
}
​
prompt_api
string
Active prompt API version label.
​
standard_ad
string
Indicates the legacy standard_ad field is accepted but ignored.
​
identify_endpoints
string
Available paths for the product identification step.
​
video_placement
string
Path and expected input for the video analysis step.
​
video_generate
string
Path and expected input for the ad generation step.

​
GET /api/ai/status

Returns only the AI provider configuration flags. Useful for a lightweight dependency check. 
curl http://127.0.0.1:8000/api/ai/status
Response 
{
  "gemini_configured": true,
  "elevenlabs_configured": false
}
​
gemini_configured
boolean
true if GEMINI_API_KEY is set in the environment.
​
elevenlabs_configured
boolean
true if ELEVENLABS_API_KEY is set in the environment.
If elevenlabs_configured is false, generating ad videos will fail unless ALLOW_SILENT_VOICEOVER=1 is set. See generate ad video for details.