Getting Started

Set up access, understand the API contract, and prepare your workspace before you make requests.

Getting Started

Set up access, understand the API contract, and prepare your workspace before you make requests.

Introduction

Welcome to the official Interlinked API documentation. Our REST API lets you create, train, and operate conversational AI agents directly from your own backend while keeping responses in standard JSON.

Before you integrate

To start making requests, you need:

An active Interlinked account.
A valid Workspace ID.
An API key generated from your dashboard.

Core architecture

Interlinked expects a server-to-server integration model. Your backend authenticates with the API, orchestrates agent actions, and stores any business-specific context you need to pass into the workflows.

Typical implementation flow

Create or identify the workspace that owns the agents.
Generate and store the API key in your backend secrets.
Connect channels, automation rules, or external systems from your server.
Validate authentication with a simple account or workspace request before expanding into more advanced flows.

Authentication