Quick Start
Get up and running with the UseInstant API in under 5 minutes.
Get your API key
Sign up and navigate to Settings → API Keys to generate your key.
Make your first request
Use curl or your favorite HTTP client.
curl https://api.useinstant.com/v1/workflows \
-H "Authorization: Bearer YOUR_API_KEY"Create a workflow
You're ready to automate!
Authentication
All API requests require authentication using Bearer tokens.
Keep your API keys secure
Never expose your API keys in client-side code or public repositories.
Example Request
curl https://api.useinstant.com/v1/workflows \
-H "Authorization: Bearer ui_live_abc123..." \
-H "Content-Type: application/json"API Key Formats
- •
ui_live_...- Production keys - •
ui_test_...- Test mode keys
Workflows
Create, update, and manage your automation workflows.
/v1/workflows Create a new workflow.
Request Body
{"
"name": "High Priority Alerts",
"description": "Send alerts for high priority events",
"trigger": {"
"type": "webhook",
"path": "/alerts"
},
"actions": [
{"
"type": "filter",
"condition": "data.priority === 'high'"
},
{"
"type": "slack",
"channel": "#alerts",
"message": "🚨 {{data.message}}"
}
]
}Response
{"
"id": "wf_abc123",
"name": "High Priority Alerts",
"status": "active",
"webhook_url": "https://hooks.useinstant.com/abc123",
"created_at": "2025-11-20T00:00:00Z"
}/v1/workflows List all workflows.
Response
{"
"data": [
{"
"id": "wf_abc123",
"name": "High Priority Alerts",
"status": "active"
}
],
"total": 1,
"page": 1
}/v1/workflows/:id Delete a workflow.
Executions
View and manage workflow executions.
/v1/workflows/:id/executions List all executions for a workflow.
Response
{"
"data": [
{"
"id": "exec_xyz789",
"workflow_id": "wf_abc123",
"status": "success",
"duration_ms": 245,
"started_at": "2025-11-20T00:00:00Z",
"completed_at": "2025-11-20T00:00:01Z"
}
]
}Webhooks
Trigger workflows via HTTP webhooks.
Triggering a Workflow
curl https://hooks.useinstant.com/abc123 \
-X POST \
-H "Content-Type: application/json" \
-d '{"priority": "high", "message": "System alert"}'Pro tip: Webhook URLs are unique per workflow and don't require authentication.
Error Handling
The API uses standard HTTP status codes.
200 Success - Request completed successfully
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid API key
404 Not Found - Resource doesn't exist
429 Rate Limited - Too many requests
500 Server Error - Something went wrong
Error Response
{"
"error": {"
"code": "invalid_request",
"message": "Missing required field: name",
"details": {"
"field": "name"
}
}
}Official SDKs
Install our SDK for your preferred language.
Ready to get started?
Create your free account and start building automations today.
Get Your API Key