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

# Quickstart Guide

> Developer guide: get started with the Kakiyo API in minutes. This page is for programmatic access — if you want to use Kakiyo from the dashboard, see the Dashboard Guides instead.

<Info>
  **This page is for developers.** It covers API setup and code examples. If you're looking for how to use Kakiyo from the dashboard (no code), see the [Dashboard Guides](/guides/overview) instead.
</Info>

This guide will help you quickly get started with the Kakiyo API to automate your LinkedIn outreach campaigns.

## Overview

Kakiyo's API allows you to:

1. Create and manage outreach campaigns
2. Add and manage prospects
3. Create and use AI-powered message templates
4. Manage AI agents that handle the conversations
5. Track performance and results

## Prerequisites

Before you begin, you'll need:

* A Kakiyo account ([sign up here](https://app.kakiyo.com/signup))
* An API key (generated from your dashboard)
* Basic understanding of RESTful APIs and HTTP requests

## Authentication

All API requests must include your API key in the Authorization header:

```bash theme={null}
Authorization: Bearer API_KEY
```

Your API key is a 40-character string.

<Note>
  Keep your API key secure! Do not share it publicly or include it in client-side code.
</Note>

## Basic Example

Here's a simple example of how to use the Kakiyo API to create a campaign:

<CodeGroup>
  ```javascript JavaScript theme={null}
  const axios = require('axios');

  const API_KEY = 'YOUR_API_KEY';
  const BASE_URL = 'https://api.kakiyo.com/v1';

  // Create a new campaign
  async function createCampaign() {
    try {
      const response = await axios.post(
        `${BASE_URL}/campaigns`,
        {
          name: 'My First Campaign',
          productId: 'product123',
          promptId: 'prompt456',
          agentId: 'agent789',
          qualificationAutomatic: 70,
          qualificationVerification: 50,
          variables: {
            companyValue: "Our unique AI solution",
            painPoint: "time-consuming manual outreach"
          }
        },
        {
          headers: {
            'Authorization': `Bearer ${API_KEY}`,
            'Content-Type': 'application/json'
          }
        }
      );

      console.log('Campaign created:', response.data);
      return response.data;
    } catch (error) {
      console.error('Error creating campaign:', error.response ? error.response.data : error.message);
      throw error;
    }
  }

  // Call the function
  createCampaign();
  ```

  ```python Python theme={null}
  import requests

  API_KEY = 'YOUR_API_KEY'
  BASE_URL = 'https://api.kakiyo.com/v1'

  # Create a new campaign
  def create_campaign():
      try:
          response = requests.post(
              f'{BASE_URL}/campaigns',
              json={
                  'name': 'My First Campaign',
                  'productId': 'product123',
                  'promptId': 'prompt456',
                  'agentId': 'agent789',
                  'qualificationAutomatic': 70,
                  'qualificationVerification': 50,
                  'variables': {
                      'companyValue': 'Our unique AI solution',
                      'painPoint': 'time-consuming manual outreach'
                  }
              },
              headers={
                  'Authorization': f'Bearer {API_KEY}',
                  'Content-Type': 'application/json'
              }
          )

          response.raise_for_status()
          print('Campaign created:', response.json())
          return response.json()
      except requests.exceptions.RequestException as e:
          print('Error creating campaign:', e)
          raise

  # Call the function
  if __name__ == '__main__':
      create_campaign()
  ```

  ```curl cURL theme={null}
  curl -X POST "https://api.kakiyo.com/v1/campaigns" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "My First Campaign",
      "productId": "product123",
      "promptId": "prompt456",
      "agentId": "agent789",
      "qualificationAutomatic": 70,
      "qualificationVerification": 50,
      "variables": {
        "companyValue": "Our unique AI solution",
        "painPoint": "time-consuming manual outreach"
      }
    }'
  ```
</CodeGroup>

## Common Workflow

A typical workflow with the Kakiyo API looks like this:

1. **Setup your environment**:
   * Create products that describe your offerings
   * Create prompts/templates for your messaging
   * Create and configure AI agents

2. **Create a campaign**:
   * Define campaign parameters
   * Set qualification criteria
   * Link to appropriate product, prompt, and agent

3. **Add prospects**:
   * Add individual prospects or batches
   * Include LinkedIn profile URLs and any additional information

4. **Monitor and manage**:
   * Track campaign performance
   * Manage conversations
   * Qualify prospects based on responses

## Next Steps

Now that you've seen a basic example, explore the rest of our documentation to learn more:

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock" href="/authentication">
    Learn more about authentication methods and security
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse the complete API documentation
  </Card>

  <Card title="Campaigns API" icon="bullhorn" href="/api-reference/campaigns/create">
    Learn how to create and manage campaigns
  </Card>

  <Card title="Prospects API" icon="user-group" href="/api-reference/prospects/add-batch">
    Learn how to add and manage prospects
  </Card>
</CardGroup>