Skip to main content
An active Xyleme (Bravais/Syndicate) account with valid login credentials is required. Contact your organization’s Xyleme administrator if you don’t have access.

​
Finding Your Subdomain

Your subdomain is the unique identifier for your organization’s Xyleme platform and is required to connect to the correct API endpoint.

1

Locate Your Xyleme URL

Identify your subdomain from your Xyleme login URL.

  • Open your web browser and navigate to your organization’s Xyleme login page
  • Look at the URL in your browser’s address bar
2

Extract the Subdomain

Your subdomain is the portion of the URL before .bravais.com.

  • If your URL is https://mycompany.bravais.com, your subdomain is mycompany
  • If your URL is https://core-mycompany.bravais.com, your subdomain is core-mycompany
  • The subdomain is case-sensitive; enter it exactly as it appears in your URL

​
Obtaining Your Username

Your username is the email address associated with your Xyleme account.

1

Identify Your Login Email

Use the email address you use to sign in to Xyleme.

  • This is typically your work email address
  • The username is the same email you enter on the Xyleme login page
  • If you use SSO (Single Sign-On), contact your Xyleme administrator for your API-enabled account credentials

​
Confirming Your Password

Your password is the same password you use to log in to your Xyleme account.

1

Use Your Existing Password

Enter the password associated with your Xyleme account.

  • This is the same password you use on the Xyleme login page
  • If you’ve forgotten your password, use the “Forgot Password” link on your Xyleme login page to reset it
  • Ensure your password is current and has not expired
2

SSO Users

If your organization uses Single Sign-On (SAML 2.0) for Xyleme authentication, you may need a separate API-enabled account.

  • Contact your Xyleme administrator to request API access credentials
  • SSO credentials may not work directly with the API; a dedicated API user account may be required
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.