AI Detection

curl --request POST \
  --url https://text.external-api.pangram.com/task \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "text": "<string>"
}
'

import requests

url = "https://text.external-api.pangram.com/task"

payload = { "text": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "task_id": "<string>",
  "stage": "<string>",
  "text": "<string>",
  "version": "<string>",
  "headline": "<string>",
  "prediction": "<string>",
  "prediction_short": "<string>",
  "fraction_ai": 123,
  "fraction_ai_assisted": 123,
  "fraction_human": 123,
  "num_ai_segments": 123,
  "num_ai_assisted_segments": 123,
  "num_human_segments": 123,
  "dashboard_link": "<string>",
  "windows": [
    {
      "text": "<string>",
      "label": "<string>",
      "ai_assistance_score": 123,
      "confidence": "<string>",
      "start_index": 123,
      "end_index": 123,
      "word_count": 123,
      "token_length": 123
    }
  ]
}

POST

task

AI Detection

curl --request POST \
  --url https://text.external-api.pangram.com/task \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "text": "<string>"
}
'

import requests

url = "https://text.external-api.pangram.com/task"

payload = { "text": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "task_id": "<string>",
  "stage": "<string>",
  "text": "<string>",
  "version": "<string>",
  "headline": "<string>",
  "prediction": "<string>",
  "prediction_short": "<string>",
  "fraction_ai": 123,
  "fraction_ai_assisted": 123,
  "fraction_human": 123,
  "num_ai_segments": 123,
  "num_ai_assisted_segments": 123,
  "num_human_segments": 123,
  "dashboard_link": "<string>",
  "windows": [
    {
      "text": "<string>",
      "label": "<string>",
      "ai_assistance_score": 123,
      "confidence": "<string>",
      "start_index": 123,
      "end_index": 123,
      "word_count": 123,
      "token_length": 123
    }
  ]
}

Current

Async inference API

Current version

The current AI detection API creates an async task and returns a task ID. Poll the task endpoint until it reaches STAGE_SUCCESS or STAGE_FAILED.

Use the Bulk API when you need to analyze many texts as one asynchronous job.

POST /task

Create an async AI detection task.

POST https://text.external-api.pangram.com/task

Request

text

string

required

The input text to analyze.

public_dashboard_link

boolean

default:"false"

Whether to include a public dashboard link in the completed response.

Response

task_id

string

The ID of the async inference task.

Example

curl -X POST https://text.external-api.pangram.com/task \
  -H "Content-Type: application/json" \
  -H "x-api-key: your_api_key_here" \
  -d '{
    "text": "The text to analyze with Pangram",
    "public_dashboard_link": false
  }'

from pangram import Pangram

pangram_client = Pangram()
result = pangram_client.predict("The text to analyze with Pangram")

Example Response

{
  "task_id": "123e4567-e89b-12d3-a456-426614174000"
}

GET /task/

Fetch the current status or completed result for an AI detection task.

GET https://text.external-api.pangram.com/task/{task_id}

Request

task_id

string

required

The task ID returned by POST /task.

Response

task_id

string

The ID of the async inference task. Present while the task is in progress.

stage

string

Current task stage. Terminal stages are STAGE_SUCCESS and STAGE_FAILED.

text

string

The input text that was analyzed. Present on success.

version

string

The API version identifier (e.g., "3.0"). Present on success.

headline

string

Classification headline summarizing the result. Present on success.

prediction

string

Long-form prediction string describing the classification. Present on success.

prediction_short

string

Short-form prediction string (e.g., "AI", "AI-Assisted", "Human", "Mixed"). Present on success.

fraction_ai

float

Fraction of text classified as AI-written (0.0–1.0). Present on success.

fraction_ai_assisted

float

Fraction of text classified as AI-assisted (0.0–1.0). Present on success.

fraction_human

float

Fraction of text classified as human-written (0.0–1.0). Present on success.

num_ai_segments

integer

Number of text segments classified as AI. Present on success.

num_ai_assisted_segments

integer

Number of text segments classified as AI-assisted. Present on success.

num_human_segments

integer

Number of text segments classified as human. Present on success.

dashboard_link

string

A link to the dashboard page containing the full classification result. Present on success when public_dashboard_link is true.

windows

array

List of text segments () analyzed individually. Present on success.

Show Window object properties

text

string

The window text.

label

string

Descriptive classification label (e.g., "AI-Generated", "Moderately AI-Assisted").

ai_assistance_score

float

detailing the level of AI assistance (0.0–1.0).

confidence

string

for the classification ("High", "Medium", "Low").

start_index

integer

Starting character index in the original text.

end_index

integer

Ending character index in the original text.

word_count

integer

Number of words in the window.

token_length

integer

Token length of the window.

Example

cURL

curl -X GET https://text.external-api.pangram.com/task/123e4567-e89b-12d3-a456-426614174000 \
  -H "x-api-key: your_api_key_here"

In-Progress Response

{
  "task_id": "123e4567-e89b-12d3-a456-426614174000",
  "stage": "STAGE_PREPROCESSING"
}

Success Response

{
  "stage": "STAGE_SUCCESS",
  "text": "The text to analyze with Pangram",
  "version": "3.0",
  "headline": "AI Detected",
  "prediction": "We are confident that this document contains AI-generated or AI-assisted content.",
  "prediction_short": "Mixed",
  "fraction_ai": 0.70,
  "fraction_ai_assisted": 0.20,
  "fraction_human": 0.10,
  "num_ai_segments": 7,
  "num_ai_assisted_segments": 2,
  "num_human_segments": 1,
  "dashboard_link": "https://www.pangram.com/history/123e4567-e89b-12d3-a456-426614174000",
  "windows": [
    {
      "text": "The text to analyze",
      "label": "AI-Generated",
      "ai_assistance_score": 0.85,
      "confidence": "High",
      "start_index": 0,
      "end_index": 19,
      "word_count": 4,
      "token_length": 5
    },
    {
      "text": "with Pangram",
      "label": "Moderately AI-Assisted",
      "ai_assistance_score": 0.45,
      "confidence": "Medium",
      "start_index": 20,
      "end_index": 32,
      "word_count": 2,
      "token_length": 3
    }
  ]
}

Failed Response

{
  "stage": "STAGE_FAILED",
  "text": "",
  "version": "",
  "headline": "preprocessing: Input text contains no valid text after preprocessing",
  "prediction": "",
  "prediction_short": "",
  "fraction_ai": 0.0,
  "fraction_ai_assisted": 0.0,
  "fraction_human": 0.0,
  "num_ai_segments": 0,
  "num_ai_assisted_segments": 0,
  "num_human_segments": 0,
  "windows": []
}

API Overview Bulk API

REST API

Deprecated

AI Detection

POST /task

Request

Response

Example

GET /task/

Request

Response

Example

​POST /task

​Request

​Response

​Example

​GET /task/

​Request

​Response

​Example

POST /task

Request

Response

Example

GET /task/

Request

Response

Example