Skip to main content

Quickstart

Get started with Helix Humanize in under 5 minutes. This guide walks you through submitting text for humanization and retrieving the results.

Prerequisites​

Before you begin, you'll need:

Step 1: Submit Text for Humanization​

Submit text that you want rewritten to sound more natural and human. You can optionally provide a style guide.

curl -X POST https://api.feeds.onhelix.ai/humanize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "It is important to note that the utilization of comprehensive strategies can facilitate the optimization of outcomes. Furthermore, leveraging innovative approaches demonstrates the implementation of robust methodologies."
  }'

Response (202 Accepted):

{
  "success": true,
  "data": {
    "jobId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Save the jobId value -- you'll need it to check the results.

Step 2: Check Status​

Poll the status endpoint until the job completes:

curl "https://api.feeds.onhelix.ai/humanize/550e8400-e29b-41d4-a716-446655440000/status" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "success": true,
  "data": {
    "jobId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "running"
  }
}

The job is complete when status is completed or failed. Status values: running, completed, failed.

Step 3: Retrieve Results​

Once the status is completed, retrieve the humanized text:

curl "https://api.feeds.onhelix.ai/humanize/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "success": true,
  "data": {
    "jobId": "550e8400-e29b-41d4-a716-446655440000",
    "originalText": "It is important to note that the utilization of comprehensive strategies can facilitate the optimization of outcomes. Furthermore, leveraging innovative approaches demonstrates the implementation of robust methodologies.",
    "modifications": [
      [
        {
          "fragment": {
            "prefix": "",
            "match": "It is important to note that the utilization of comprehensive strategies can facilitate the optimization of outcomes.",
            "suffix": " Furthermore"
          },
          "replaceWith": "Using broad strategies helps improve outcomes.",
          "reasoning": "Removed hedging phrase and replaced formal vocabulary with simpler alternatives"
        },
        {
          "fragment": {
            "prefix": "outcomes. ",
            "match": "Furthermore, leveraging innovative approaches demonstrates the implementation of robust methodologies.",
            "suffix": ""
          },
          "replaceWith": "Taking fresh approaches also shows that solid methods are in place.",
          "reasoning": "Replaced formal transitions and vocabulary with natural phrasing"
        }
      ]
    ],
    "rewrittenText": "Using broad strategies helps improve outcomes. Taking fresh approaches also shows that solid methods are in place."
  }
}

Understanding the Results​

The response contains three key fields:

  • originalText -- The text you submitted, exactly as provided
  • modifications -- An array of modification batches. Each batch is an array of individual changes, where each change specifies the original text fragment that was replaced, the replacement text, and a brief reasoning
  • rewrittenText -- The final humanized text with all modifications applied

Each modification uses a fragment (prefix + match + suffix) to identify exactly which part of the text was changed, making it easy to see what was modified and why.

Common Patterns​

Polling with Retry​

JOBID="550e8400-e29b-41d4-a716-446655440000"

while true; do
  STATUS=$(curl -s "https://api.feeds.onhelix.ai/humanize/$JOBID/status" \
    -H "Authorization: Bearer YOUR_API_KEY" | jq -r '.data.status')

  if [ "$STATUS" = "completed" ] || [ "$STATUS" = "failed" ]; then
    break
  fi

  sleep 5
done

curl "https://api.feeds.onhelix.ai/humanize/$JOBID" \
  -H "Authorization: Bearer YOUR_API_KEY"

Using a Style Guide​

Provide a style guide to influence how the text is rewritten:

curl -X POST https://api.feeds.onhelix.ai/humanize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "The implementation of this methodology facilitates enhanced outcomes.",
    "styleGuide": "Write in a conversational, first-person tone. Use contractions. Keep sentences short."
  }'

The style guide tells the humanizer what voice and tone to target, helping it produce output that matches your brand or publication standards.

Next Steps​