Habitica API

Name: Habitica API
Brand: Habitica API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentProductivityTask ManagementapiKey58 EndpointsREST

For Agents

Score habits and dailies, manage todos and rewards, run group challenges and quests, and trigger Habitica webhooks on behalf of a gamified-productivity user.

Install Jentic One Beta

Connect the Habitica API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Habitica API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Habitica API.

Score habits, dailies, and todos up or down to award gold and experience

Create, update, and reorder tasks within a user's task list

Run party and guild quests, including invite, accept, and force-start flows

GET STARTED

Start building with Habitica API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Habitica API for, with concrete tasks.

★ Gamified Habit Coaching Agent

Build an AI accountability coach that scores Habitica habits and dailies on behalf of the user as real-world events occur. The agent listens for triggers (calendar events, fitness app data, journal entries) and calls the score endpoint to award gold and experience for completed routines. Habitica handles the gamification layer - HP loss, level-ups, gear drops - while the agent owns the trigger logic. Setup takes a few hours with the user's API token.

Score the habit with id abc-123 in the positive direction and report the user's new gold and experience totals.

Party Quest Coordinator

Coordinate multi-player Habitica quests by inviting party members, watching for accept events, and force-starting once a quorum is reached. The quest endpoints expose invite, accept, reject, cancel, abort, and force-start verbs against a group id. This is useful for guild leaders running long-running boss quests and for community managers who run themed event quests.

Invite all members of party 'guild-42' to the Vice Drake quest and force-start it once at least four members have accepted.

Daily Reset Reporting

Generate end-of-day reports on which dailies the user actually completed, how much HP was lost, and which streaks survived. The agent pulls the user's tasks list filtered by daily type, inspects the completed flag and streak counter, and writes a digest into a journaling tool. Useful for self-reflection workflows and ADHD support agents.

Pull all dailies for the user, list which were completed today versus missed, and report current streak counts for each daily.

Webhook-Driven Reward Pipeline

Register a Habitica webhook that fires whenever a task is scored, then route those events into an external rewards or notification system. The agent owns webhook registration via the user webhooks endpoint and consumes payloads describing task id, direction, and resulting drops. Integration runs in well under an hour through Jentic.

Create a Habitica webhook of type 'taskActivity' that posts to https://example.com/hooks/habitica and confirm it returns active=true.

Agent Discovery Through Jentic

AI agents discover Habitica operations by searching Jentic with intents like 'score a habit' or 'invite to party quest' and receive matching operations with their input schemas. The agent loads the schema, fills in the task id and direction, and executes through the Jentic SDK without ever browsing the Habitica wiki. Credentials stay isolated in the Jentic vault.

Use the Jentic search 'score a habit' to find the Habitica scoring operation, load its schema, and execute it for taskId 'abc-123' with direction 'up'.

Key Endpoints

58 endpoints — habitica is a gamified habit-tracking and task-management platform that turns daily routines into a role-playing game.

METHOD

PATH

DESCRIPTION

GET

/user

Get the authenticated user's profile and stats

POST

/tasks/user

Create a new task for the user

POST

/tasks/{taskId}/score/{direction}

Score a habit, daily, or todo up or down

GET

/tasks/user

List all tasks owned by the user

POST

/groups/{groupId}/chat

Post a chat message to a group

POST

/challenges

Create a new challenge with prize gems

POST

/user/webhooks

GET

/user

Get the authenticated user's profile and stats

POST

/tasks/user

Create a new task for the user

POST

/tasks/{taskId}/score/{direction}

Score a habit, daily, or todo up or down

GET

/tasks/user

List all tasks owned by the user

POST

/groups/{groupId}/chat

Post a chat message to a group

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Habitica's x-api-user and x-api-key headers are stored encrypted in the Jentic vault and injected only at execution time. Agents see scoped access tokens, never the raw user id or API key.

Intent-based discovery

Agents search Jentic by intent (e.g. 'score a habit', 'invite to party quest') and Jentic returns the matching Habitica operations with their input schemas, so the agent can call the right endpoint without browsing the Habitica wiki.

Time to first call

Direct Habitica integration: half a day to a day to handle the dual-header auth, task scoring semantics, and webhook lifecycle. Through Jentic: under an hour to search, load, and execute.

FAQs

Specific to using Habitica API through Jentic.

What authentication does the Habitica API use?

Habitica uses two API key headers: x-api-user with the user id and x-api-key with the user's API token, both sourced from the Habitica account settings page. Through Jentic, both values stay encrypted in the vault and are injected at execution time, so agents never receive the raw token in their context.

Can I score habits and dailies with the Habitica API?

Yes. POST /tasks/{taskId}/score/{direction} scores any habit, daily, or todo in the up or down direction and returns the resulting gold, experience, HP, and item drops. Negative habits and missed dailies will reduce HP rather than award rewards.

What are the rate limits for the Habitica API?

Habitica rate-limits requests per user token and returns 429 responses when limits are exceeded. The platform has historically published a limit of around 30 requests per minute per user; check the X-RateLimit-Remaining header on responses for the current allowance and back off when it nears zero.

How do I register a Habitica webhook through Jentic?

Search Jentic for 'register habitica webhook' to load the POST /user/webhooks operation, then execute it with a target URL and a type such as taskActivity, groupChatReceived, or questActivity. Jentic returns the webhook id which you can use later to update or delete it.

Is the Habitica API free to use?

Yes. Habitica is open source and the API is free for personal use. The platform asks third-party tools to set a User-Agent identifying the integration so the maintainers can contact authors if a tool causes issues.

Can I run party quests through the API?

Yes. The /groups/{groupId}/quests/* endpoints support invite, accept, reject, cancel, abort, force-start, and leave operations. The user calling the endpoint must be a member of the group, and force-start requires being the quest leader or group leader.

Habitica API

Connect the Habitica API to your agent

Capabilities

Start building with Habitica API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs