Edit a Worker

POST

/workers/update

curl -X POST https://api.xholic.ai/v1/workers/update \
  -H "Authorization: Bearer $XHOLIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workerId":"<workerId>","changes":{},"dryRun":true}'

const response = await fetch("https://api.xholic.ai/v1/workers/update", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.XHOLIC_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "workerId": "<workerId>",
    "changes": {},
    "dryRun": true
  }),
});
const result = await response.json();
console.log(result.summary);

import axios from "axios";

const { data } = await axios.post(
  "https://api.xholic.ai/v1/workers/update",
  {
    "workerId": "<workerId>",
    "changes": {},
    "dryRun": true
  },
  { headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` } },
);
console.log(data.summary);

import os
import requests

response = requests.post(
    "https://api.xholic.ai/v1/workers/update",
    headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"},
    json={
        "workerId": "<workerId>",
        "changes": {},
        "dryRun": True
    },
)
print(response.json()["summary"])

package main

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

func main() {
  body := strings.NewReader(`{"workerId":"<workerId>","changes":{},"dryRun":true}`)
  req, _ := http.NewRequest("POST", "https://api.xholic.ai/v1/workers/update", body)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("XHOLIC_API_KEY"))
  req.Header.Set("Content-Type", "application/json")
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  out, _ := io.ReadAll(res.Body)
  fmt.Println(string(out))
}

<?php
$ch = curl_init("https://api.xholic.ai/v1/workers/update");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('XHOLIC_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{"workerId":"<workerId>","changes":{},"dryRun":true}',
]);
$result = json_decode(curl_exec($ch), true);
echo $result['summary'];

require "net/http"
require "json"

uri = URI("https://api.xholic.ai/v1/workers/update")
req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")
req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"
req.body = '{"workerId":"<workerId>","changes":{},"dryRun":true}'
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)["summary"]

Change a Worker’s instructions, voice, topics, products, size or schedule. Call it only when the user asked for this in the conversation; never on your own initiative.

Authorizations

bearerAuth

Request Body^required

application/json

object

workerId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

changes

required

object

name

string

>= 1 characters <= 80 characters

status

PAUSED saves the worker without running it, for when the plan’s active workers are all in use.

string

Allowed values: ACTIVE PAUSED

voiceMode

OWN is “My voice”; CREATOR writes in the creators’ style; HYBRID is the user’s voice with the creators’ rhythm.

string

Allowed values: OWN CREATOR HYBRID

creatorXIds

Creator xid values from findWorkerCreators: one for HYBRID unless the user asks for more (up to three), one to three for CREATOR, none for OWN.

Array<string>

<= 3 items

instructions

The worker’s brief, broad boundaries only: who it writes for, who speaks, how the account likes to write, the areas it usually writes in, when to mention products and hard bans. Never a thesis, a point of view to push or specific topics to cover.

string

nullable <= 2000 characters

applyAccountRules

Follow the account’s saved writing rules.

boolean

mirrorProvenPosts

Shape posts on formats that already work in the niche.

boolean

topicMode

FOR_YOU is “For you” (topics from the profile); PRODUCT is “Your products”; CUSTOM_TOPIC is a custom topic; NICHE_TRENDING follows what is trending for its keywords.

string

Allowed values: FOR_YOU PRODUCT CUSTOM_TOPIC NICHE_TRENDING

customTopic

CUSTOM_TOPIC: what to post about. NICHE_TRENDING: one to five comma-separated keywords.

string

nullable <= 500 characters

productIds

PRODUCT only: saved product IDs from getAutomationSetup or getAccountContext.

Array<string>

<= 5 items

outputCount

Any of:

number

Allowed values: 8

scheduleMode

string

Allowed values: ON_DEMAND DAILY WEEKLY

scheduleTimeMinutes

DAILY or WEEKLY: minutes after midnight in the account’s timezone, e.g. 540 for 9:00.

integer

nullable <= 1439

scheduleDayOfWeek

WEEKLY: 0 is Sunday, 6 is Saturday.

integer

nullable <= 6

account

X account to act on, as @handle. Leave it out to use the connection’s default account.

string

>= 1 characters <= 64 characters

dryRun

Return exactly what would happen without doing it.

boolean

idempotencyKey

A unique key for this write. Repeating a call with the same key returns the first result instead of acting twice.

string

>= 8 characters <= 200 characters

Example

{
  "workerId": "<workerId>",
  "changes": {},
  "dryRun": true
}

Responses

200

Success

application/json

object

required

boolean

summary

required

One or two readable sentences about the result.

string

data

required

The result. Its shape depends on the action.

ids

object

key

additional properties

any

next

Array<string>

creditsCharged

number

dryRun

boolean

Example

{
  "ok": true
}

default

Error

application/json

object

required

boolean

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED INVALID_CREDENTIAL SCOPE_MISSING ROLE_NOT_PERMITTED ACCOUNT_NOT_FOUND SUBSCRIPTION_REQUIRED FEATURE_NOT_INCLUDED APP_ONLY INVALID_INPUT NOT_FOUND CONFLICT CREDITS_CONFIRMATION_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS X_DATA_LIMIT_REACHED UPSTREAM_UNAVAILABLE INTERNAL_ERROR

message

required

string

scope

required

string

Allowed values: account platform

retryAfterSeconds

integer

details

Example

{
  "ok": false,
  "error": {
    "code": "UNAUTHENTICATED",
    "scope": "account"
  }
}

Edit a Worker

Authorizations

Request Bodyrequired

Example

Responses

200

Example

default

Example

Request Body^required