{"openapi":"3.1.0","info":{"title":"Habitify (BYOK) API","version":"0.1.0","description":"Habitify (BYOK) lets an AI assistant read your own Habitify data through the Habitify API with a key you supply (Habitify API key (paid plan)). Read-only: 7 tools (list_habits, get_habit, get_habit_journal, get_habit_statistics, list_habit_notes, list_areas, get_area). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-habitify.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-habitify/docs"},"termsOfService":"https://connectorbay.com/byok-habitify/terms"},"servers":[{"url":"https://byok-habitify.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-habitify/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_habits":{"post":{"operationId":"list_habits","summary":"List your habits with type (good or bad), archived flag, goals, areas and start date. Needs a paid Habitify plan. Use fo","description":"List your habits with type (good or bad), archived flag, goals, areas and start date. Needs a paid Habitify plan. Use for \"Which habits do I track in Habitify\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for archived habits only, false for active ones only (omit for both).","title":"Archived"},"area_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only habits assigned to this area id.","title":"Area Id"},"type":{"anyOf":[{"enum":["good","bad"],"type":"string"},{"type":"null"}],"default":null,"description":"Only good or bad habits.","title":"Type"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many habits to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many habits to skip, for paging.","title":"Offset"}},"title":"list_habitsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_habit":{"post":{"operationId":"get_habit","summary":"Get one habit with its goals, areas, time-of-day periods and end condition. Use for \"Show the details of my reading habi","description":"Get one habit with its goals, areas, time-of-day periods and end condition. Use for \"Show the details of my reading habit in Habitify\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"habit_id":{"description":"Habit identifier, as returned by list_habits.","maxLength":200,"title":"Habit Id","type":"string"}},"required":["habit_id"],"title":"get_habitArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_habit_journal":{"post":{"operationId":"get_habit_journal","summary":"Show every habit's status for one day (completed, skipped, failed or in progress) with current streak and progress towar","description":"Show every habit's status for one day (completed, skipped, failed or in progress) with current streak and progress toward the goal. Use for \"Which habits did I complete today in Habitify\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Day to show, YYYY-MM-DD (default: today in your timezone).","title":"Date"}},"title":"get_habit_journalArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_habit_statistics":{"post":{"operationId":"get_habit_statistics","summary":"Get completion, skip and failure counts, total logged value and an optional daily breakdown for one habit over a date ra","description":"Get completion, skip and failure counts, total logged value and an optional daily breakdown for one habit over a date range. Use for \"How consistent have I been with my reading habit this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"habit_id":{"description":"Habit identifier, as returned by list_habits.","maxLength":200,"title":"Habit Id","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day, YYYY-MM-DD (default: the habit's start date).","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day, YYYY-MM-DD (default: today).","title":"End Date"}},"required":["habit_id"],"title":"get_habit_statisticsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_habit_notes":{"post":{"operationId":"list_habit_notes","summary":"List the notes attached to one habit, newest first, with text, mood level and creation time. Use for \"What notes did I w","description":"List the notes attached to one habit, newest first, with text, mood level and creation time. Use for \"What notes did I write on my meditation habit\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"habit_id":{"description":"Habit identifier, as returned by list_habits.","maxLength":200,"title":"Habit Id","type":"string"}},"required":["habit_id"],"title":"list_habit_notesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_areas":{"post":{"operationId":"list_areas","summary":"List your areas (life categories such as Health or Work) used to group habits. Use for \"Which areas do I use to group ha","description":"List your areas (life categories such as Health or Work) used to group habits. Use for \"Which areas do I use to group habits in Habitify\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_areasArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_area":{"post":{"operationId":"get_area","summary":"Get one area's name, colour and creation time. Use for \"Show the area with a given id in Habitify\".","description":"Get one area's name, colour and creation time. Use for \"Show the area with a given id in Habitify\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"area_id":{"description":"Area identifier, as returned by list_areas.","maxLength":200,"title":"Area Id","type":"string"}},"required":["area_id"],"title":"get_areaArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}