Key context

Which key is making the request, what it can see and which limits apply to it right now.

Endpoints

GET/v1/me

#The ApiContext object

Details of the key used for the request: organization, permissions, scope, limits and collection status.

Attributes

objectstring
Object type, always api_context.
key_idstring (uuid)
Key ID. The key secret is never returned in responses.
organizationobject
The organization on whose behalf the key acts.
Child attributes
- idstring (uuid)
  Organization ID.
- namestring
  Organization name.
scopesarray of string
Read permissions granted to the key. Up to 4 items.
scopeobject
Key scope: which workspaces and campaigns it can see.
Child attributes
- workspace_modestring
  all: all workspaces of the organization; selected: only the listed ones. Values: all selected
- workspace_idsarray of string
  Selected workspaces. An empty array when workspace_mode=all. Up to 50 items.
- workspace_include_futureboolean
  Whether workspaces created after the key was issued are included in the scope.
- campaign_modestring
  all: all campaigns in the selected workspaces; selected: only the listed ones. Values: all selected
- campaign_idsarray of string
  Selected campaigns. An empty array when campaign_mode=all. Up to 500 items.
- campaign_include_futureboolean
  Whether campaigns created after the key was issued are included in the scope.
- scope_versioninteger
  Scope version number. Increases with every change to the key's scope or permissions.
api_versionstring
API version, always v1.
expires_atstring (date-time) or null
When the key expires. null if no expiry is set.
limitsobject
Rate limits currently applied to the key.
Child attributes
- key_secondinteger
  Weight units per second per key.
- key_minuteinteger
  Weight units per minute per key.
- org_secondinteger
  Weight units per second per organization, across all keys combined.
- org_minuteinteger
  Weight units per minute per organization, across all keys combined.
- key_concurrentinteger
  Concurrent requests per key.
- org_concurrentinteger
  Concurrent requests per organization.
- max_response_bytesstring
  Maximum response size in bytes (1 MiB). Long pages are shortened, no data is lost. Always 1048576.
- modestring
  normal: normal mode; emergency: temporarily reduced limits. Values: normal emergency
collectionobject
Status of saved conversation collection for the API.
Child attributes
- statestring
  running: collection is active; paused: paused in Meliora; preparing: preparing after being enabled; degraded: data may be incomplete. Values: running paused preparing degraded
- enabled_atstring (date-time) or null
  When collection was enabled. null if it has not been enabled yet.
- pause_pendingboolean
  A pause or resume was requested in Meliora but has not been applied yet.

ApiContext

{
  "object": "api_context",
  "key_id": "9b1e7c42-5a6d-4f83-9e0b-2d7c4a8f1e65",
  "organization": {
    "id": "2c8f4a61-7d3e-4b9a-8f21-6a0d5e9c3b17",
    "name": "Example"
  },
  "scopes": [
    "campaigns:read",
    "events:read",
    "leads:read",
    "messages:read"
  ],
  "scope": {
    "workspace_mode": "all",
    "workspace_ids": [],
    "workspace_include_future": true,
    "campaign_mode": "all",
    "campaign_ids": [],
    "campaign_include_future": true,
    "scope_version": 1
  },
  "api_version": "v1",
  "expires_at": null,
  "limits": {
    "key_second": 5,
    "key_minute": 300,
    "org_second": 10,
    "org_minute": 600,
    "key_concurrent": 5,
    "org_concurrent": 10,
    "max_response_bytes": 1048576,
    "mode": "normal"
  },
  "collection": {
    "state": "running",
    "enabled_at": "2026-10-20T08:00:00.000Z",
    "pause_pending": false
  }
}

#Retrieve API key details

GET/v1/me

Returns the organization, permissions, scope and limits of the key. Use it as the first request to check the connection. Available to a key with any set of permissions.

Permission: any read permission
Request weight: 1

Parameters

No parameters.

Response

Returns a ApiContext object.

Endpoint-specific errors

scope_required: The key does not have permission for this read. Texts also require "Message text" to be enabled.
not_found: The object was not found or is outside the key's scope. An unknown path also returns 404.

Common errors are described in Errors.

Request

curl https://api.melioralab.io/v1/me \
  -H "Authorization: Bearer $MELIORA_API_KEY"

const res = await fetch('https://api.melioralab.io/v1/me', {
  headers: { Authorization: `Bearer ${process.env.MELIORA_API_KEY}` },
});
if (!res.ok) throw new Error(`Meliora API: ${res.status}`);
const body = await res.json();

import os
import requests

resp = requests.get(
    "https://api.melioralab.io/v1/me",
    headers={"Authorization": f"Bearer {os.environ['MELIORA_API_KEY']}"},
    timeout=15,
)
resp.raise_for_status()
body = resp.json()

Response

{
  "object": "api_context",
  "key_id": "9b1e7c42-5a6d-4f83-9e0b-2d7c4a8f1e65",
  "organization": {
    "id": "2c8f4a61-7d3e-4b9a-8f21-6a0d5e9c3b17",
    "name": "Example"
  },
  "scopes": [
    "campaigns:read",
    "events:read",
    "leads:read",
    "messages:read"
  ],
  "scope": {
    "workspace_mode": "all",
    "workspace_ids": [],
    "workspace_include_future": true,
    "campaign_mode": "all",
    "campaign_ids": [],
    "campaign_include_future": true,
    "scope_version": 1
  },
  "api_version": "v1",
  "expires_at": null,
  "limits": {
    "key_second": 5,
    "key_minute": 300,
    "org_second": 10,
    "org_minute": 600,
    "key_concurrent": 5,
    "org_concurrent": 10,
    "max_response_bytes": 1048576,
    "mode": "normal"
  },
  "collection": {
    "state": "running",
    "enabled_at": "2026-10-20T08:00:00.000Z",
    "pause_pending": false
  }
}