Getting started

Quickstart

Submit a document, poll the check, and read the scores, in curl, Node.js or Python. Ten minutes from key to report.

Get a key

Create one under Account, then API in the Silvertext app and put it in your environment:

export SILVERTEXT_API_KEY=st_live_…

Submit a document

Send the text with the checks you want. Every option defaults to on, so the shortest body is { "text": "…" }.

curl -X POST https://api.silvertext.com/v1/checks \
  -H "Authorization: Bearer $SILVERTEXT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Q3 launch post",
    "text": "Your document text…",
    "options": { "plagiarism": true, "grammarSpelling": true,
                 "citations": false, "aiContent": true, "style": true },
    "citationStyle": "APA"
  }'

The response is the check id:

{ "id": "9b2f1c34-7c1d-4c7e-9a44-2f6f4be8d915" }

Poll until it is done

Ask for the summary view while polling; it carries the status, progress and scores without the full report.

curl "https://api.silvertext.com/v1/checks/$CHECK_ID?view=summary" \
  -H "Authorization: Bearer $SILVERTEXT_API_KEY"

A finished check looks like this:

{
  "id": "9b2f1c34-7c1d-4c7e-9a44-2f6f4be8d915",
  "status": "done",
  "title": "Q3 launch post",
  "wordCount": 1184,
  "originalityScore": 86,
  "coverage": 1,
  "scores": { "plagiarism": 14, "grammarSpelling": 2, "citation": 0, "aiContent": 9, "clarity": 6 },
  "issueCounts": { "grammar": 3, "citations": 0 }
}

Read the findings

Fetch the parts you use. include=issues,sources returns every finding with its fix and the sources behind the plagiarism matches:

curl "https://api.silvertext.com/v1/checks/$CHECK_ID?include=issues,sources" \
  -H "Authorization: Bearer $SILVERTEXT_API_KEY"

Reading the report walks through the shape. The report also opens in the app at https://app.silvertext.com/reports/{id}.

Next

On this page