Welcome to the Hipo.ai API Documentation—a curated guide to seamlessly integrate with our ecosystem and amplify your digital presence.
It verifies your API key—confirming, in the most genuine way, that you are who you say you are—and then returns key details such as your name and available credits.
No data required
curl https://www.hipo.ai/v1/me/ \ -X POST \ -H "Content-Type: application/json" \ -H "X-API-KEY: $HIPO_API_KEY"
Create messages that are not just generic notifications but genuine expressions, ensuring your communication feels both meaningful and personal.
{
"channel": "email",
"tone": "informal",
"max_token": 100,
"framework": "pain-gain",
"instruct": null,
"enrich": true,
"linkedin_url": "https://www.linkedin...",
"reason": true
}
curl https://www.hipo.ai/v1/message/ \
-X POST \
-H "Content-Type: application/json" \
-H "X-API-KEY: $HIPO_API_KEY" \
-d '{
"channel": "email",
"tone": "informal",
"framework": "pain-gain",
"max_token": 100,
"reason": true,
}'
Path Parameters
| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
| channel | str | 'email' | True | Platform you want to generate the message for. Available options: ['email', 'linkedin', 'whatsapp', 'notification'] |
| tone | str | 'informal' | True | Specifies the tone for the message. Available options: ['informal', 'formal', 'friendly', 'humorous'] |
| max_token | int | 100 | True | Maximum number of the words message should contain. |
| framework | str | 'pain-gain' | True | Platform you want to generate the message for. Available options: ['email', 'linkedin', 'whatsapp', 'notification'] |
| enrich | bool | true | False | If true, requires 'linkedin_url' |
| reason | bool | true | False | Allow model to reason before generating the message. |
| hops | int | 1 | False | Under Experiment Number of hops to get the output. Each hop will cost 1 additional credit. Example: 1 message with 3 hops will cost 3 credits. |
This endpoint is your canvas for defining the ideal customer profile (ICP). It lets you shape a vivid picture of your perfect customer, much like engaging in a thoughtful conversation with your future business partner.
Note: Approval required to call this endpoint.
{
"mode": "website",
"website": "https://www.hipo.ai"
}
curl https://www.hipo.ai/v1/create-persona/ \
-X POST \
-H "Content-Type: application/json" \
-H "X-API-KEY: $HIPO_API_KEY" \
-d '{
"mode": "trained",
}'
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| asd |
This endpoint is your canvas for listing all the ideal customer profile (ICP).
Note: Approval required to call this endpoint.
{}
curl https://www.hipo.ai/v1/create-persona/ \ -H "Content-Type: application/json" \ -H "X-API-KEY: $HIPO_API_KEY"
Get details about the individual persona.
Note: Approval required to call this endpoint.
{}
curl https://www.hipo.ai/v1/create-persona/ \ -H "Content-Type: application/json" \ -H "X-API-KEY: $HIPO_API_KEY"
Delete persona by ID.
Note: Approval required to call this endpoint.
{}
curl https://www.hipo.ai/v1/create-persona/ \ -X DELETE \ -H "Content-Type: application/json" \ -H "X-API-KEY: $HIPO_API_KEY"
This API endpoint is used to train our AI Agents more about the your business, your offerings, your documents, your Youtube videos and more.
Note: Approval required to call this endpoint.
{
"mode": "website",
"urls": [...]
}
curl https://www.hipo.ai/v1/train/ \
-X POST \
-H "Content-Type: application/json" \
-H "X-API-KEY: $HIPO_API_KEY" \
-d '{
"mode": "website",
"urls": [...]
}'
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| asd |
This API endpoint is used to train our AI Agents more about the your business, your offerings, your documents, your Youtube videos and more.
Note: Approval required to call this endpoint.
{}
curl https://www.hipo.ai/v1/train/ \ -H "Content-Type: application/json" \ -H "X-API-KEY: $HIPO_API_KEY"
This API endpoint is used to train our AI Agents more about the your business, your offerings, your documents, your Youtube videos and more.
Note: Approval required to call this endpoint.
{}
curl https://www.hipo.ai/v1/train/ \ -H "Content-Type: application/json" \ -H "X-API-KEY: $HIPO_API_KEY"
This API endpoint is used to train our AI Agents more about the your business, your offerings, your documents, your Youtube videos and more.
Note: Approval required to call this endpoint.
{}
curl https://www.hipo.ai/v1/train/ \ -X DELETE \ -H "Content-Type: application/json" \ -H "X-API-KEY: $HIPO_API_KEY"
Our comprehensive retention resources, expert advice, and supportive community are here to guide and help you every step of the way.
Join our newsletter, let's stir a change. Free