Skip to main content
Output Framework home page
Search...
⌘K
Ask AI
Reference
growthxai/output
Search...
Navigation
API Reference
Health check the API
Home
Start Here
Getting Started
Claude Code
Learning Path
Workflows
The workflow.ts File
Execution Context
Composing with Child Workflows
Parallel Execution
External Integration
Running Workflows
Steps
The steps.ts File
Step Patterns & Best Practices
Prompts
Writing Prompt Files
Templating with Variables
Production Prompts
Clients
Connecting to External APIs
Costs
Cost Estimation
Cost Events
Evaluators
Overview
Evaluator Step
Evaluation Workflow
LLM-as-a-Judge Best Practices
Production Readiness
Credentials
Error Handling
Error Hooks
Testing Workflows and Steps
Tracing: Full Visibility
Deployment
Deployment overview
Deploy to Render
Deploy to Railway
Advanced configuration
Integrate with Your App
Overview
Configuration
Authentication
Error Responses
API Reference
GET
Health check the API
POST
Execute a workflow synchronously
POST
Start a workflow asynchronously
GET
Get workflow execution status
PATCH
Stop a workflow execution
POST
Terminate a workflow execution (force stop)
POST
Reset a workflow to re-run from after a specific step
GET
Return the result of a workflow
GET
Get workflow trace log data
GET
Get a specific workflow catalog by ID
GET
Get the default workflow catalog
GET
List workflow runs
POST
Send feedback to a workflow
POST
Send a signal to an workflow
POST
Send a query to an workflow
POST
Execute an update on an workflow
POST
A dummy post endpoint for test only
Packages
@outputai/core
@outputai/cli
@outputai/credentials
@outputai/evals
@outputai/http
@outputai/llm
Health check the API
cURL
Copy
Ask AI
curl
--request
GET
\
--url
http://localhost:3001/health
API Reference
Health check the API
Copy page
Copy page
GET
/
health
Try it
Health check the API
cURL
Copy
Ask AI
curl
--request
GET
\
--url
http://localhost:3001/health
Response
200
It is healthy
Error Responses
Execute a workflow synchronously
⌘I
Assistant
Responses are generated using AI and may contain mistakes.