humanOShumanOS
Developer Platform

Build with the humanOS API

Integrate AI-driven scheduling, productivity insights, and life optimization into your own applications with our RESTful API.

Get API KeyView Endpoints
Quick Start
# Get your optimized schedule
curl -X GET https://api.humanos.ai/v1/schedule/today \
-H "Authorization: Bearer your_api_key"

What You Can Build

The humanOS API gives developers, integrators, and partners access to our AI optimization engine through a clean, well-documented REST interface.

Smart Scheduling

Fetch AI-optimized schedules, create and manage events, and get intelligent scheduling suggestions based on energy patterns.

Productivity Insights

Access detailed analytics on focus time, task completion rates, energy trends, and AI-generated performance recommendations.

Automation & Triggers

Set up automated workflows triggered by schedule changes, energy shifts, goal completions, or custom conditions.

Webhooks

Receive real-time notifications when events occur — schedule updates, goal milestones, optimization suggestions, and more.

User Profiles

Read and update user preferences, energy profiles, work styles, and personalization settings programmatically.

Integrations

Manage connected third-party services, sync data from external sources, and build custom integration pipelines.

Authentication & Rate Limits

Secure, token-based authentication with generous rate limits that scale with your plan.

Authentication

All API requests require a Bearer token passed in the Authorization header. API keys are generated from your account dashboard and can be scoped with specific permissions.

Authentication
# Include in all requests
Authorization: Bearer hos_live_sk_...
# Key prefixes
hos_live_sk_* # Production key
hos_test_sk_* # Sandbox key
  • Separate keys for production and sandbox environments
  • Granular permission scopes (read, write, admin)
  • Key rotation without downtime via rolling keys
  • All keys transmitted over TLS 1.3 only

Rate Limits

Rate limits scale with your subscription plan. Headers in every response tell you your current usage.

Plan
Requests / min
Requests / day
Basic
30
5,000
Essential
120
50,000
Ultimate
600
500,000
Enterprise
Custom
Custom
Rate Limit Headers
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 117
X-RateLimit-Reset: 1706745600

API Endpoints

A clean, RESTful interface organized around the core resources of the humanOS platform.

Schedule

/v1/schedule
GET/v1/schedule/today
GET/v1/schedule/{date}
POST/v1/schedule/optimize
POST/v1/schedule/events
PATCH/v1/schedule/events/{id}
DELETE/v1/schedule/events/{id}

Insights

/v1/insights
GET/v1/insights/productivity
GET/v1/insights/energy
GET/v1/insights/recommendations
GET/v1/insights/summary/{period}

User

/v1/user
GET/v1/user/profile
PATCH/v1/user/profile
GET/v1/user/integrations
DELETE/v1/user/integrations/{id}

Webhooks

/v1/webhooks
GET/v1/webhooks
POST/v1/webhooks
PATCH/v1/webhooks/{id}
DELETE/v1/webhooks/{id}

Code Examples

Get up and running in minutes. Here are some common API patterns.

Fetch Today's Optimized Schedule

JavaScript
const response = await fetch(
"https://api.humanos.ai/v1/schedule/today",
{
headers: { "Authorization": `Bearer ${API_KEY}` }
}
);
const schedule = await response.json();

Sample Response

JSON Response
{
"date": "2026-02-08",
"optimization_score": 94,
"events": [
{
"time": "08:00",
"title": "Deep Focus Work",
"type": "focus",
"energy_alignment": "peak"
}
],
"ai_insight": "Peak energy 8-11 AM — complex tasks scheduled here."
}

Register a Webhook

cURL
curl -X POST https://api.humanos.ai/v1/webhooks \
-H "Authorization: Bearer hos_live_sk_..." \
-H "Content-Type: application/json" \
-d '{"url":"https://your-app.com/webhooks/humanos","events":["schedule.updated","goal.completed"]}'

SDKs & Libraries

Official client libraries for popular languages. Use the API directly or let an SDK handle the details.

JavaScript / TypeScript

Available
npm install @humanos/sdk

Python

Available
pip install humanos

Go

Coming Soon
go get humanos.ai/sdk

Ruby

Coming Soon
gem install humanos

Versioning & Changelog

Predictable versioning and clear communication about changes.

Versioning Policy

  • API version is included in the URL path (e.g., /v1/)
  • Breaking changes result in a new major version
  • Non-breaking additions are made to the current version
  • Previous versions supported for at least 12 months after deprecation notice
  • Deprecation warnings included in response headers

Recent Changes

v1.3.0
Jan 2026
Added /insights/recommendations endpoint, webhook retry logic
v1.2.0
Dec 2025
Added energy pattern analysis, webhook event filtering
v1.1.0
Nov 2025
Added schedule optimization endpoint, user preference updates
v1.0.0
Oct 2025
Initial public release — schedule, user, and webhook endpoints

Getting Started

From sign-up to your first API call in under 5 minutes.

1

Create an Account

Sign up for a free humanOS account. All plans include API access with sandbox keys for development.

2

Generate an API Key

Navigate to Dashboard > Settings > API Keys and create a new key. Choose permission scopes and copy your secret key.

3

Make Your First Request

Use the sandbox key to test against our API. Start with GET /v1/schedule/today to see your optimized schedule.

4

Go Live

When ready, swap your sandbox key for a production key and deploy. Monitor usage from your API dashboard.

Ready to Build with humanOS?

Get your API key today and start integrating AI-powered life optimization into your applications.

Free tier includes 5,000 requests/day | Full API documentation available

Get API KeyContact Developer Support