> ## Documentation Index
> Fetch the complete documentation index at: https://docs.starleads.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to Starleads

> Conversational AI platform — phone, web-widget, SMS & WhatsApp. Integrate with our API to manage campaigns, prospects, and receive results in real-time.

Starleads is a **conversational AI platform** that deploys intelligent agents across multiple channels — **phone** (inbound & outbound), **web-widget**, **SMS**, and **WhatsApp**. From customer support to marketing and sales, Starleads handles your conversations at scale. Our public API lets you manage campaigns, add and remove prospects, and receive conversation results — all programmatically.

<Tip>**New here?** Follow the steps below to get up and running in 5 minutes.</Tip>

## Getting Started

<Steps>
  <Step title="Get your API key" icon="key">
    Sign up at [app.starleads.co](https://app.starleads.co) and retrieve your API key from your account settings. You'll need it for every API request — it goes in the `X-Api-Key` header. Check the [Authentication guide](/documentation/authentification) for details.
  </Step>

  <Step title="Make your first API call" icon="code">
    Use the API to list your campaigns, add prospects, or retrieve campaign data. Explore the available endpoints in the [API Reference](#api-reference) section below.
  </Step>

  <Step title="Receive results in real-time" icon="webhook">
    Set up a webhook to get notified whenever one of your AI agents completes a conversation. You'll receive the full result — including classification, transcript, and summary. See the [Receive Conversation Results](/documentation/receive-conversation-results) guide for setup instructions.
  </Step>
</Steps>

## Guides

Deep-dive into key features:

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/documentation/authentification">
    Learn how to authenticate your API requests using your API key.
  </Card>

  <Card title="Receive Conversation Results" icon="webhook" href="/documentation/receive-conversation-results">
    Get your agents' conversation results in real-time via webhooks.
  </Card>

  <Card title="Knowledge Base (RAG)" icon="brain" href="../documentation/rag-knowledge-base">
    Build AI-powered knowledge bases with datasets, documents, and chat assistants for your voice agents.
  </Card>
</CardGroup>

## API Reference

Explore the available endpoints:

<Note>**Base URL**: `https://api.starleads.co` — All requests require the `X-Api-Key` header.</Note>

<CardGroup cols={3}>
  <Card title="Create a campaign" icon="plus" href="../api-reference/campaign/create-a-campaign">
    Create a new campaign associated with an AI agent
  </Card>

  <Card title="Get all campaigns" icon="bullhorn" href="../api-reference/campaign/get-all-campaigns">
    List all your campaigns.
  </Card>

  <Card title="Get campaign fields" icon="circle-info" href="../api-reference/campaignfield/get-campaigns-fields">
    Retrieve the fields of a specific campaign.
  </Card>

  <Card title="Get items by phone" icon="calendar-users" href="../api-reference/campaignitem/get-all-items-by-phone-number">
    Find all prospect entries for a phone number.
  </Card>

  <Card title="Add a campaign item" icon="phone-plus" href="../api-reference/campaignitem/add-a-new-campaign-item-to-a-campaign">
    Add a new prospect to a campaign.
  </Card>

  <Card title="Delete a campaign item" icon="trash" href="../api-reference/campaignitem/delete-an-item-from-a-campaign">
    Remove a prospect entry from a campaign.
  </Card>

  <Card title="Get agent prompt" icon="robot" href="../api-reference/agent/get-the-prompt-of-an-agent">
    Retrieve the current prompt of an AI agent
  </Card>

  <Card title="Update agent prompt" icon="pen-to-square" href="../api-reference/agent/update-the-prompt-of-an-agent">
    Update the prompt that drives your agent's behavior
  </Card>
</CardGroup>