Connect an application

Create a Relay.Haus API keyCopy Anchor Link

Sign in to Relay.Haus, open the dashboard's API keys section, and create a key for the application or environment that will use it. Copy the key when it is shown and save it in your server-side secret manager (for example, your Railway service variables).

The API key belongs to your Relay.Haus account. It is not a Textbee API key, Firebase credential, or Android device API key.

Configure the production API URLCopy Anchor Link

Set the base URL to:

https://api.relay.haus/api/v1

Send the API key on each request using the x-api-key HTTP header. Keep the key on a trusted backend: do not put it in browser JavaScript, a public mobile app, or a repository.

export RELAYHAUS_API_KEY="your-dashboard-issued-key"
export RELAYHAUS_API_URL="https://api.relay.haus/api/v1"

Check the connectionCopy Anchor Link

List devices paired with the account. A successful response includes the account's device records; select an enabled device if you plan to pass a deviceId when sending.

curl "$RELAYHAUS_API_URL/gateway/devices" \
  -H "x-api-key: $RELAYHAUS_API_KEY"

Every request is scoped to the account that owns the API key. A missing, invalid, or revoked key returns 401. Store keys in your production secret manager and rotate them from the dashboard if they are exposed.