Reference of the Hapti users endpoints: parameters, fields and real responses.
Every endpoint takes a key in the Authorization header: Authorization: Bearer hp_test_.... Base address: https://api.hapti.dev. The full specification is in openapi.json .
# Create a person
HTTP Copy POST /v1/users
Registers a person you act for, with their country, language and time zone. Tasks with the same user share one device, one session and one memory.
Field Type Description id (required)string namestring countrystring localestring timezonestring mandateMandate
Response 201 Copy {
"object": "user",
"id": "customer_42",
"name": "Ana Silva",
"created_at": "2026-11-22T18:40:56.163Z",
"mandate": null,
"session": null,
"device": {
"locale": "pt-PT",
"timezone": "Europe/Lisbon",
"country": "pt",
"country_set": true,
"since": "2026-11-22T18:40:56.165Z"
},
"limits": null,
"accounts": []
}
# List people
HTTP Copy GET /v1/users
Parameter In Description limitquery Up to 100 qquery Search cursorquery next_cursor of the previous page
# Get a person
HTTP Copy GET /v1/users/{user}
Parameter In Description userpath Your own id for the person, like customer_42
# Update a person
HTTP Copy PATCH /v1/users/{user}
Name, country, language, time zone and limits.
Parameter In Description userpath Your own id for the person, like customer_42
Field Type Description namestring countrystring localestring timezonestring limitsobject
# Forget a person
HTTP Copy DELETE /v1/users/{user}
Erases the person: session, memory, stored accounts, mandate, inbox and received messages.
Parameter In Description userpath Your own id for the person, like customer_42
# Give a mandate
HTTP Copy POST /v1/users/{user}/mandate
Records what the agent may do for the person without asking each time, and who agreed to it.
Parameter In Description userpath Your own id for the person, like customer_42
Field Type Description scope (required)string What the agent may do for the person. given_by (required)string Who gave it, or how the person agreed. sitesarray untilstring
Response 200 Copy {
"mandate": {
"scope": "Declare insurance claims and download invoices",
"sites": [],
"given_by": "Ana Silva, in the app on 2026-11-20",
"until": null,
"given_at": "2026-11-22T18:40:56.233Z"
}
}
# Revoke the mandate
HTTP Copy DELETE /v1/users/{user}/mandate
Parameter In Description userpath Your own id for the person, like customer_42
# List stored accounts
HTTP Copy GET /v1/users/{user}/accounts
Accounts the agent may sign in with for this person. Secrets are never returned.
Parameter In Description userpath Your own id for the person, like customer_42
# Store an account
HTTP Copy PUT /v1/users/{user}/accounts/{account}
Saves sign-in details in the vault, sealed. The agent types them in the browser; the model never sees them.
Parameter In Description userpath Your own id for the person, like customer_42 accountpath
Field Type Description origin (required)string usernamestring password (required)string totp_secretstring
Response 200 Copy {
"account": "insurer",
"label": "insurer",
"origin": "https://portal.example.com",
"has_username": true,
"has_totp": false,
"entered_by": "developer",
"updated_at": "2026-11-22T18:40:56.235Z"
}
# Delete an account
HTTP Copy DELETE /v1/users/{user}/accounts/{account}
Parameter In Description userpath Your own id for the person, like customer_42 accountpath
# Create a connect link
HTTP Copy POST /v1/users/{user}/connect
A page where the person enters their own sign-in details. You never see them.
Parameter In Description userpath Your own id for the person, like customer_42
Field Type Description accountsarray brandstring return_urlstring expires_ininteger
# Revoke connect links
HTTP Copy DELETE /v1/users/{user}/connect
Parameter In Description userpath Your own id for the person, like customer_42
# Read the memory
HTTP Copy GET /v1/users/{user}/memory
Lasting facts the agent kept about the person, never secrets.
Parameter In Description userpath Your own id for the person, like customer_42
# Add a fact
HTTP Copy POST /v1/users/{user}/memory
Parameter In Description userpath Your own id for the person, like customer_42
Field Type Description fact (required)string
# Erase the memory
HTTP Copy DELETE /v1/users/{user}/memory
Parameter In Description userpath Your own id for the person, like customer_42
# Open an email inbox
HTTP Copy POST /v1/users/{user}/inbox
An address that receives the emails sites send to the person, such as confirmation codes, which the agent reads by itself.
Parameter In Description userpath Your own id for the person, like customer_42
Field Type Description usernamestring domainstring client_idstring
# List inboxes
HTTP Copy GET /v1/users/{user}/inbox
Parameter In Description userpath Your own id for the person, like customer_42
# List received emails
HTTP Copy GET /v1/users/{user}/emails
Parameter In Description userpath Your own id for the person, like customer_42 sincequery ISO date limitquery Up to 100
# Give a phone number
HTTP Copy POST /v1/users/{user}/phone
A real number that receives the texts sites send. Live keys only, paid monthly from the credit.
Parameter In Description userpath Your own id for the person, like customer_42
Field Type Description countrystring
# Get the phone number
HTTP Copy GET /v1/users/{user}/phone
Parameter In Description userpath Your own id for the person, like customer_42
# Release the phone number
HTTP Copy DELETE /v1/users/{user}/phone
Parameter In Description userpath Your own id for the person, like customer_42
# List received texts
HTTP Copy GET /v1/users/{user}/sms
Parameter In Description userpath Your own id for the person, like customer_42
# Usage of a person
HTTP Copy GET /v1/users/{user}/usage
Tasks and amounts billed for this person.
Parameter In Description userpath Your own id for the person, like customer_42 fromquery YYYY-MM-DD toquery YYYY-MM-DD