Getting Started

Establish your API, tenant boundary, credentials, and regional endpoint, then validate a first read before building a Concurrence workflow.

For a new Platform project, follow the workspace setup and verified conversation path below. If you maintain an existing Classic integration or use Scribe, choose its separate credential flow in Choose Credentials. Channel provisioning, data connections, and a configured service are additional prerequisites for a working agent interaction.

A first project has separate access, configuration, and verification steps.

Build Your First Project

Choose the path that matches your access:

You have	Start here
Node.js and npm, with no workspace access yet	First Verified Conversation, Local walkthrough. Run the SDK against fixtures and inspect the result file.
Console access and a configured test service	First Console Conversation. Send a text question, inspect the answer, and end the session in your browser.
A configured test service and Platform API credentials	First Verified Conversation, Provisioned test service. Verify an answer in durable history and confirm closure.

The prerequisites below apply when connecting to a deployment. The local walkthrough needs no Concurrence account, service, or key.

Prerequisites

Confirm with your implementation team	Platform API	Classic API
Tenant boundary	Workspace ID for workspace resources	Organization ID and the user represented by the credential
Endpoint	Assigned Platform regional hostname	Assigned Classic regional hostname
Credential	Workspace key or the scoped token required by the chosen route	API key, key ID, and user ID for the token exchange
Workflow configuration	Service, selected versions, eligible tools, and the required channel binding	Service, selected version set, and the relevant user permissions

Keep long-lived credentials in your backend or secret manager. Browser and external-user workflows need their documented access boundary; publishing a workspace key in a client bundle does not create one.

Essential Reading

1. Core Concepts maps the resource names and boundaries.
2. Regions & Endpoints explains hostname selection.
3. Choose Credentials identifies the caller, tenant, and accepted authentication flow.
4. Govern a Deployment records channel, feature, and regional prerequisites.

Build Your First Application

Platform

1. Install the Platform SDK.
2. Configure the client with the assigned workspace and regional hostname.
3. Run the read-only listing example in the Quickstart.
4. Choose an explicitly configured test service before starting a conversation or simulation. Review its data access and integration actions as well as its agent instructions.
5. Use Conversations to choose the channel and lifecycle required by your application.

Classic

1. Install a Classic SDK.
2. Configure the client for the correct organization and user.
3. Follow Hello World to create a conversation and consume its event stream.
4. Handle stream errors and completion explicitly, then apply the conversation lifecycle appropriate to your application.

Key Resources

A successful authenticated read confirms access to that operation. It does not establish that a channel is provisioned, source data is ready, or a workflow can complete an external action.

Continue with Guides for implementation paths. Use Evaluating Concurrence to define the evidence for a broader technical evaluation, and the API Reference to inspect operation schemas.