API

Every winstonai.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Detect

aiImage

detect.aiImage Score whether a public image URL was created by a human or generated by AI Risk: read

await corsair.winstonai.api.detect.aiImage({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`version`	`string`	No	—

Output

Name	Type	Required	Description
`score`	`number`	Yes	—
`human_probability`	`number`	No	—
`ai_probability`	`number`	No	—
`version`	`string`	No	—
`mime_type`	`string`	No	—
`credits_used`	`number`	No	—
`credits_remaining`	`number`	No	—

aiText

detect.aiText Score whether text, a public file, or a website was written by a human or generated by AI Risk: read

await corsair.winstonai.api.detect.aiText({});

Input

Name	Type	Required	Description
`text`	`string`	No	—
`file`	`string`	No	—
`website`	`string`	No	—
`version`	`string`	No	—
`sentences`	`boolean`	No	—
`language`	`string`	No	—

Output

Name	Type	Required	Description
`status`	`number`	No	—
`score`	`number`	Yes	—
`sentences`	`object[]`	No	—
`input`	`string`	No	—
`attack_detected`	`object`	No	—
`readability_score`	`number`	No	—
`credits_used`	`number`	No	—
`credits_remaining`	`number`	No	—
`version`	`string`	No	—
`language`	`string`	No	—

sentences full type

{
  text: string,
  score: number
}[]

attack_detected full type

{
  zero_width_space?: boolean,
  homoglyph_attack?: boolean
}

plagiarism

detect.plagiarism Scan text, a public file, or a website for matching sources on the web Risk: read

await corsair.winstonai.api.detect.plagiarism({});

Input

Name	Type	Required	Description
`text`	`string`	No	—
`file`	`string`	No	—
`website`	`string`	No	—
`excluded_sources`	`string[]`	No	—
`language`	`string`	No	—
`country`	`string`	No	—

Output

Name	Type	Required	Description
`status`	`number`	No	—
`scanInformation`	`object`	No	—
`result`	`object`	No	—
`sources`	`object[]`	No	—
`attackDetected`	`object`	No	—
`text`	`string`	No	—
`credits_used`	`number`	No	—
`credits_remaining`	`number`	No	—

scanInformation full type

{
  service?: string,
  scanTime?: string,
  inputType?: string,
  language?: string
}

result full type

{
  score?: number,
  sourceCounts?: number,
  textWordCounts?: number,
  totalPlagiarismWords?: number,
  identicalWordCounts?: number,
  similarWordCounts?: number
}

sources full type

{
  score?: number,
  canAccess?: boolean,
  url?: string,
  title?: string,
  plagiarismWords?: number,
  identicalWordCounts?: number,
  similarWordCounts?: number,
  totalNumberOfWords?: number,
  author?: string | null,
  description?: string | null,
  publishedDate?: number | null,
  source?: string | null,
  citation?: boolean,
  plagiarismFound?: {
    startIndex?: number,
    endIndex?: number,
    sequence?: string | null
  }[],
  is_excluded?: boolean
}[]

attackDetected full type

{
  zero_width_space?: boolean,
  homoglyph_attack?: boolean
}

Text

compare

text.compare Compare two texts and return similarity scores Risk: read

await corsair.winstonai.api.text.compare({});

Input

Name	Type	Required	Description
`first_text`	`string`	Yes	—
`second_text`	`string`	Yes	—

Output

Name	Type	Required	Description
`status`	`number`	No	—
`similarity_score`	`number`	Yes	—
`first_text`	`object`	No	—
`second_text`	`object`	No	—
`credits_used`	`number`	No	—
`credits_remaining`	`number`	No	—

first_text full type

{
  total_word_count?: number,
  matching_word_count?: number,
  similarity_percentage?: number,
  items?: {
    type?: string,
    word_count?: number,
    index_start?: number,
    length?: number
  }[]
}

second_text full type

{
  total_word_count?: number,
  matching_word_count?: number,
  similarity_percentage?: number,
  items?: {
    type?: string,
    word_count?: number,
    index_start?: number,
    length?: number
  }[]
}

Overview

Plugins

Detect

aiImage

aiText

plagiarism

Text

compare

​Detect

​aiImage

​aiText

​plagiarism

​Text

​compare

Detect

aiImage

aiText

plagiarism

Text

compare