Create Agent

curl --request POST \
  --url https://api.kakiyo.com/v1/agents \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kakiyo.com/v1/agents"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kakiyo.com/v1/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kakiyo.com/v1/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kakiyo.com/v1/agents"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kakiyo.com/v1/agents")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kakiyo.com/v1/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "agent_12345abcde",
  "message": "Agent created successfully"
}

{
  "error": "validation_error",
  "message": "The request parameters failed validation",
  "details": [
    {
      "field": "name",
      "message": "The name field is required"
    }
  ]
}

{
  "error": "validation_error",
  "message": "The request parameters failed validation",
  "details": [
    {
      "field": "name",
      "message": "The name field is required"
    }
  ]
}

POST

agents

Create Agent

curl --request POST \
  --url https://api.kakiyo.com/v1/agents \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kakiyo.com/v1/agents"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kakiyo.com/v1/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kakiyo.com/v1/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kakiyo.com/v1/agents"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kakiyo.com/v1/agents")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kakiyo.com/v1/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "agent_12345abcde",
  "message": "Agent created successfully"
}

{
  "error": "validation_error",
  "message": "The request parameters failed validation",
  "details": [
    {
      "field": "name",
      "message": "The name field is required"
    }
  ]
}

{
  "error": "validation_error",
  "message": "The request parameters failed validation",
  "details": [
    {
      "field": "name",
      "message": "The name field is required"
    }
  ]
}

Overview

Create a new LinkedIn automation agent for your team. This endpoint handles the complete agent setup process including profile creation, proxy assignment, and initial configuration. The agent will be ready for campaign assignment once created.

Request Body

name

string

required

Display name for the agent (used in dashboard and reports)

string

required

Email address for the LinkedIn account (must be unique)

password

string

required

Password for the LinkedIn account (minimum 8 characters)

firstName

string

required

First name for the LinkedIn profile

lastName

string

required

Last name for the LinkedIn profile

workingHours

object

Agent working hours configuration

Show workingHours properties

start

string

default:"09:00"

Start time in HH:MM format

end

string

default:"17:00"

End time in HH:MM format

timezone

string

default:"UTC"

Timezone for working hours

days

array

Working days of the week

limits

object

Daily activity limits for the agent

Show limits properties

dailyConnections

number

default:"20"

Maximum connection requests per day

dailyMessages

number

default:"50"

Maximum messages per day

dailyProfileViews

number

default:"100"

Maximum profile views per day

Use Cases

Team Expansion: Add new agents to increase outreach capacity
Geographic Coverage: Create agents for different time zones
Campaign Specialization: Dedicated agents for specific campaigns
Load Distribution: Balance workload across multiple agents

Request Example

{
  "name": "Sales Agent - West Coast",
  "email": "agent.westcoast@company.com",
  "password": "SecurePassword123!",
  "firstName": "Sarah",
  "lastName": "Johnson",
  "workingHours": {
    "start": "08:00",
    "end": "16:00",
    "timezone": "America/Los_Angeles",
    "days": ["monday", "tuesday", "wednesday", "thursday", "friday"]
  },
  "limits": {
    "dailyConnections": 25,
    "dailyMessages": 60,
    "dailyProfileViews": 120
  }
}

Response Structure

{
  "message": "Agent created successfully",
  "agent": {
    "id": "agent_123",
    "name": "Sales Agent - West Coast",
    "email": "agent.westcoast@company.com",
    "status": "setup_pending",
    "healthStatus": "initializing",
    "profile": {
      "firstName": "Sarah",
      "lastName": "Johnson",
      "profileId": "gologin_profile_456"
    },
    "workingHours": {
      "start": "08:00",
      "end": "16:00",
      "timezone": "America/Los_Angeles",
      "days": ["monday", "tuesday", "wednesday", "thursday", "friday"]
    },
    "limits": {
      "dailyConnections": 25,
      "dailyMessages": 60,
      "dailyProfileViews": 120
    },
    "proxy": {
      "assigned": true,
      "location": "United States",
      "type": "residential"
    },
    "createdAt": "2024-01-20T15:30:00Z",
    "teamId": "team_789"
  },
  "nextSteps": [
    "Complete LinkedIn profile setup",
    "Verify email address",
    "Configure automation settings",
    "Assign to campaigns"
  ]
}

Testing Example

curl -X POST "https://api.kakiyo.com/v1/agents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sales Agent - West Coast",
    "email": "agent.westcoast@company.com",
    "password": "SecurePassword123!",
    "firstName": "Sarah",
    "lastName": "Johnson",
    "workingHours": {
      "start": "08:00",
      "end": "16:00",
      "timezone": "America/Los_Angeles"
    }
  }'

// JavaScript/Node.js
const createAgent = async (agentData) => {
  const response = await fetch('https://api.kakiyo.com/v1/agents', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(agentData)
  });

  return await response.json();
};

// Usage example
const newAgent = await createAgent({
  name: 'Sales Agent - West Coast',
  email: 'agent.westcoast@company.com',
  password: 'SecurePassword123!',
  firstName: 'Sarah',
  lastName: 'Johnson',
  workingHours: {
    start: '08:00',
    end: '16:00',
    timezone: 'America/Los_Angeles'
  },
  limits: {
    dailyConnections: 25,
    dailyMessages: 60,
    dailyProfileViews: 120
  }
});

console.log('New Agent Created:', newAgent);

# Python
import requests

def create_agent(agent_data):
    """Create a new LinkedIn agent"""
    response = requests.post(
        'https://api.kakiyo.com/v1/agents',
        json=agent_data,
        headers={
            'Authorization': 'Bearer YOUR_API_KEY',
            'Content-Type': 'application/json'
        }
    )

    return response.json()

# Usage example
agent_data = {
    'name': 'Sales Agent - West Coast',
    'email': 'agent.westcoast@company.com',
    'password': 'SecurePassword123!',
    'firstName': 'Sarah',
    'lastName': 'Johnson',
    'workingHours': {
        'start': '08:00',
        'end': '16:00',
        'timezone': 'America/Los_Angeles'
    },
    'limits': {
        'dailyConnections': 25,
        'dailyMessages': 60,
        'dailyProfileViews': 120
    }
}

result = create_agent(agent_data)
print('New Agent Created:', result)

Error Responses

Email Already Exists

{
  "error": "email_exists",
  "message": "An agent with this email already exists"
}

Invalid Email Format

{
  "error": "invalid_email",
  "message": "Please provide a valid email address"
}

Weak Password

{
  "error": "weak_password",
  "message": "Password must be at least 8 characters long"
}

Team Limit Reached

{
  "error": "agent_limit_reached",
  "message": "Maximum number of agents reached for your plan"
}

Proxy Assignment Failed

{
  "error": "proxy_assignment_failed",
  "message": "Unable to assign proxy to agent. Please try again."
}

Best Practices

Unique Emails: Use unique email addresses for each agent
Strong Passwords: Use complex passwords with mixed characters
Realistic Limits: Set conservative daily limits to avoid restrictions
Geographic Distribution: Create agents in different time zones
Professional Names: Use professional names for LinkedIn profiles

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Agent created successfully

string

Example:

"agent_12345abcde"

message

string

Example:

"Agent created successfully"

Last modified on August 29, 2025

List agents Get agent details

Developer Hub

API Documentation

Analytics

Models

Campaigns

Prospects

DNC

Products

Prompts

Agents

Workspaces

Webhooks

Authentication

Create Agent

Overview

Request Body

Use Cases

Request Example

Response Structure

Testing Example

Error Responses

Email Already Exists

Invalid Email Format

Weak Password

Team Limit Reached

Proxy Assignment Failed

Best Practices

Authorizations

Response

​Overview

​Request Body

​Use Cases

​Request Example

​Response Structure

​Testing Example

​Error Responses

​Email Already Exists

​Invalid Email Format

​Weak Password

​Team Limit Reached

​Proxy Assignment Failed

​Best Practices

Authorizations

Response

Overview

Request Body

Use Cases

Request Example

Response Structure

Testing Example

Error Responses

Email Already Exists

Invalid Email Format

Weak Password

Team Limit Reached

Proxy Assignment Failed

Best Practices