Quickstart

This guide helps you make your first successful request to Xentree.

1. Choose the base URL

For most REST API calls, use:

https://my.xentree.com

For Xentree Live browser experiences:

App: https://live.xentree.com

Realtime socket: wss://orchstr.xentree.com

2. Authenticate

You can authenticate with either:

Bearer token (recommended for user-session flows)

API key (recommended for server-to-server flows)

Option A: Bearer token

Obtain an access token from the authentication endpoint.

Request

Response

{
  "access_token": "eyJ...",
  "token_type": "bearer"
}

Option B: API key

Create an API key from the Admin panel and use it in the header:

For this quickstart flow, the key should include at least:

conversations:read

conversations:write

3. Send your first chat request

You can also call the same endpoint with API key auth:

4. Create a conversation

5. Try Xentree Live

To start a Live session:

Recommended next steps

Read Authentication for token lifecycle details

Read Conversations for chat and session workflows

Read Xentree Live for voice, quota, and transcript support

Read Errors and Limits for scope-related 403 handling

1. Choose the base URL#

2. Authenticate#

Option A: Bearer token#

Request#

Response#

Option B: API key#

3. Send your first chat request#

4. Create a conversation#

5. Try Xentree Live#

Recommended next steps#