Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hevn Inc Chat API

The Chat API from Hevn Inc — 8 operation(s) for chat.

Hevn Inc Chat API is one of 31 APIs that Hevn Inc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 8 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 0.1.2.

Requests are made against a single base URL, https://api.hevn.finance.

10 operations 8 paths 7 schemas 4 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.2
Base URL
https://api.hevn.finance/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Hevn Inc Chat API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer). An API key is passed in the header as x-api-key (ApiKeyAuth).

  • ApiKeyAuth — Alternative HEVN API key header. The CLI defaults to Authorization Bearer unless configured with HEVNAPIKEYHEADER=X-Api-Key.

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 4 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Chat 10
POST
/api/v1/chat/{chat_type}
Create or get a chat
create_chat_api_v1_chat__chat_type__post 2 params body → 200422
GET
/api/v1/chat/{chat_type}/messages
Get chat messages
get_chat_messages_api_v1_chat__chat_type__messages_get 3 params → 200422
POST
/api/v1/chat/{chat_type}/messages
Send a chat message
send_chat_message_api_v1_chat__chat_type__messages_post 2 params body → 201422
POST
/api/v1/chat/{chat_type}/read
Mark chat as read by the user
mark_chat_read_api_v1_chat__chat_type__read_post 2 params → 204422
GET
/api/v1/chat/{chat_type}/stream
SSE stream for chat messages
stream_chat_api_v1_chat__chat_type__stream_get 2 params → 200422
POST
/api/v1/user/chat/{chat_type}
Create or get a chat
create_chat_package_alias_api_v1_user_chat__chat_type__post 2 params body → 200422
GET
/api/v1/user/chat/{chat_type}/messages
Get chat messages
get_chat_messages_package_alias_api_v1_user_chat__chat_type__messages_get 3 params → 200422
POST
/api/v1/user/chat/{chat_type}/messages
Send a chat message
send_chat_message_package_alias_api_v1_user_chat__chat_type__messages_post 2 params body → 201422
POST
/api/v1/user/chat/{chat_type}/read
Mark chat as read by the user
mark_chat_read_package_alias_api_v1_user_chat__chat_type__read_post 2 params → 204422
GET
/api/v1/user/chat/{chat_type}/stream
SSE stream for chat messages
stream_chat_package_alias_api_v1_user_chat__chat_type__stream_get 2 params → 200422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are app__schemas__routers__user__user__ChatResponse (7 properties), ChatMessageResponse (7 properties), ValidationError (3 properties), ChatMessageRequest (2 properties). Each schema is shown below with its type and property counts.

UserChatType
string
Chat types exposed to end users (subset of db.ChatType).
ValidationError
object
3 properties 3 required
ChatMessageResponse
object
Single message in a chat.
7 properties 4 required
app__schemas__routers__user__user__ChatResponse
object
User-facing chat.
7 properties 2 required
HTTPValidationError
object
1 property
ChatMessageRequest
object
Send a message in the chat.
2 properties 1 required
ChatCreateRequest
object
Create (or get) the user's internal chat.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hevn-inc-chat-api-openapi.yml Raw ↑

Other APIs Hevn Inc publishes across the network.

Hevn Inc 2FA API
Hevn Inc Activity API
Hevn Inc apps API
Hevn Inc apps-transfer API
Hevn Inc auth API
Hevn Inc B2B API
Hevn Inc Balance API
Hevn Inc Banks API
Hevn Inc Cards API
Hevn Inc contracts API
Hevn Inc Devices API
Hevn Inc documents API