Skip to main content
POST
/
orgs
/
{org_id}
/
deployments
Register a new self-hosted deployment
curl --request POST \
  --url https://api.mnemom.ai/v1/orgs/{org_id}/deployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instance_name": "<string>",
  "instance_id": "<string>",
  "license_id": "<string>",
  "region": "<string>",
  "version": "<string>",
  "instance_metadata": {}
}
'
{
  "deployment_id": "<string>",
  "org_id": "<string>",
  "license_id": "<string>",
  "instance_name": "<string>",
  "instance_id": "<string>",
  "region": "<string>",
  "version": "<string>",
  "heartbeat_data": {},
  "instance_metadata": {},
  "last_heartbeat_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Supabase JWT token in Authorization: Bearer header

Path Parameters

​
org_id
string
required

Organization identifier (e.g. org-abc12345)

Body

application/json
​
instance_name
string
required
​
instance_id
string
required
​
license_id
string
required
​
region
string | null
​
version
string | null
​
instance_metadata
object

Response

Deployment registered.

A self-hosted Mnemom deployment registered by an org.

​
deployment_id
string

Prefixed dep-… identifier assigned on registration.

​
org_id
string
​
license_id
string
​
instance_name
string
​
instance_id
string
​
region
string | null
​
status
enum<string>
Available options:
active,
inactive,
degraded
​
version
string | null
​
heartbeat_data
object
​
instance_metadata
object
​
last_heartbeat_at
string<date-time> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>