Rewrite with Xholic AI

POST

/composer/rewrite

curl -X POST https://api.xholic.ai/v1/composer/rewrite \
  -H "Authorization: Bearer $XHOLIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Shipping the API today","instruction":"<instruction>","mode":"selection","dryRun":true}'

const response = await fetch("https://api.xholic.ai/v1/composer/rewrite", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.XHOLIC_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "text": "Shipping the API today",
    "instruction": "<instruction>",
    "mode": "selection",
    "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/composer/rewrite",
  {
    "text": "Shipping the API today",
    "instruction": "<instruction>",
    "mode": "selection",
    "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/composer/rewrite",
    headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"},
    json={
        "text": "Shipping the API today",
        "instruction": "<instruction>",
        "mode": "selection",
        "dryRun": True
    },
)
print(response.json()["summary"])

package main

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

func main() {
  body := strings.NewReader(`{"text":"Shipping the API today","instruction":"<instruction>","mode":"selection","dryRun":true}`)
  req, _ := http.NewRequest("POST", "https://api.xholic.ai/v1/composer/rewrite", 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/composer/rewrite");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('XHOLIC_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{"text":"Shipping the API today","instruction":"<instruction>","mode":"selection","dryRun":true}',
]);
$result = json_decode(curl_exec($ch), true);
echo $result['summary'];

require "net/http"
require "json"

uri = URI("https://api.xholic.ai/v1/composer/rewrite")
req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")
req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"
req.body = '{"text":"Shipping the API today","instruction":"<instruction>","mode":"selection","dryRun":true}'
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)["summary"]

Only when the user explicitly asks for Xholic’s rewriter. Rewrites a post or a selection by an instruction, or reviews the writing (mode review). Uses Xholic AI credits: quote first and pass confirmCredits after the user agrees. Otherwise rewrite it yourself.

Uses Xholic AI credits (up to about 8). The first call returns CREDITS_CONFIRMATION_REQUIRED with a quote; after the user agrees, call again with confirmCredits and the quote’s quoteId.

Authorizations

bearerAuth

Request Body^required

application/json

object

text

required

The post, or the selected part to rewrite.

string

<= 25000 characters

instruction

required

string

>= 1 characters <= 500 characters

context

The full post around a selection.

string

<= 25000 characters

mode

required

string

Allowed values: selection post review

maxCharacters

integer

>= 1 <= 25000

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

confirmCredits

Xholic AI credits the user agreed to spend. Call first without it to get the quote, show the quote to the user, and pass the amount only after they say yes.

number

<= 100000

quoteId

The quoteId from the quote the user agreed to. Send it with confirmCredits.

string

>= 8 characters <= 100 characters

Example

{
  "text": "Shipping the API today",
  "instruction": "<instruction>",
  "mode": "selection",
  "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"
  }
}

Rewrite with Xholic AI

Authorizations

Request Bodyrequired

Example

Responses

200

Example

default

Example

Request Body^required