Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health
{
  "status": "<string>",
  "initialized": true,
  "agents": [
    {}
  ],
  "timestamp": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/darkzOGx/youtube-automation-agent/llms.txt

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

​
Endpoint

GET /health

​
Description

Returns the current health status of the YouTube Automation Agent, including initialization state and available agents. This endpoint is useful for monitoring and ensuring all components are properly initialized.

​
Request

No parameters required.

​
Headers

No special headers required.

​
Response

​
status
string
required
Current health status. Returns "healthy" when the system is operational.
​
initialized
boolean
required
Indicates whether the agent has completed initialization. true means all agents and services are ready.
​
agents
array
required
List of initialized agent names.Available agents:
  • strategy - Content Strategy Agent
  • scriptWriter - Script Writer Agent
  • thumbnailDesigner - Thumbnail Designer Agent
  • seoOptimizer - SEO Optimizer Agent
  • production - Production Management Agent
  • publishing - Publishing & Scheduling Agent
  • analytics - Analytics & Optimization Agent
​
timestamp
string
required
ISO 8601 formatted timestamp of when the health check was performed.

​
Example Request

curl http://localhost:3456/health

​
Example Response

{
  "status": "healthy",
  "initialized": true,
  "agents": [
    "strategy",
    "scriptWriter",
    "thumbnailDesigner",
    "seoOptimizer",
    "production",
    "publishing",
    "analytics"
  ],
  "timestamp": "2026-03-05T10:30:45.123Z"
}

​
Response Codes

Status CodeDescription
200Health check successful

​
Use Cases

​
System Monitoring

Use this endpoint to verify the system is running and all agents are initialized: 
# Simple health check
curl -f http://localhost:3456/health || echo "System unhealthy"

​
Startup Verification

Check initialization status before making other API calls: 
async function waitForInitialization() {
  const response = await fetch('http://localhost:3456/health');
  const health = await response.json();
  
  if (!health.initialized) {
    console.log('System still initializing...');
    // Retry after delay
  }
}

​
Docker Health Check

Use in Docker containers for health monitoring: 
HEALTHCHECK --interval=30s --timeout=3s --start-period=40s \
  CMD curl -f http://localhost:3456/health || exit 1
If initialized is false, credentials may be missing or invalid. Check the application logs and run npm run credentials:setup to configure credentials.

Build docs developers (and LLMs) love

Get started for freeTalk to us