Check a draft

GET

/drafts/check

curl 'https://api.xholic.ai/v1/drafts/check?text=Shipping+the+API+today' \
  -H "Authorization: Bearer $XHOLIC_API_KEY"

const response = await fetch("https://api.xholic.ai/v1/drafts/check?text=Shipping+the+API+today", {
  headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` },
});
const result = await response.json();
console.log(result.summary);

import axios from "axios";

const { data } = await axios.get("https://api.xholic.ai/v1/drafts/check", {
  params: {
    "text": "Shipping the API today"
  },
  headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` },
});
console.log(data.summary);

import os
import requests

response = requests.get(
    "https://api.xholic.ai/v1/drafts/check",
    headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"},
    params={
        "text": "Shipping the API today"
    },
)
print(response.json()["summary"])

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://api.xholic.ai/v1/drafts/check?text=Shipping+the+API+today", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("XHOLIC_API_KEY"))
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}

<?php
$ch = curl_init("https://api.xholic.ai/v1/drafts/check?text=Shipping+the+API+today");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('XHOLIC_API_KEY')],
]);
$result = json_decode(curl_exec($ch), true);
echo $result['summary'];

require "net/http"
require "json"

uri = URI("https://api.xholic.ai/v1/drafts/check?text=Shipping+the+API+today")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)["summary"]

Free checks before posting: length for the account’s X tier, links (Xholic drafts never contain links), near-copies of a source post, repeats of what the account posted recently, and thread structure. Run it on every draft you write; fix what it flags.

Authorizations

bearerAuth

Parameters

Query Parameters

text

required

string

>= 1 characters <= 25000 characters

Example

Shipping the API today

threadParts

For a thread: every part in order, starting with the same first post as text.

Array<string>

>= 2 items <= 25 items

For a thread: every part in order, starting with the same first post as text.

sourceText

The post you built from, to catch near-copies.

string

<= 25000 characters

The post you built from, to catch near-copies.

account

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

string

>= 1 characters <= 64 characters

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

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"
  }
}