Understanding the API Response

StealthGPT API Response Documentation

When using the StealthGPT API, the response returned will include different key items depending on the endpoint used.

/stealthify Endpoint

The /stealthify endpoint provides the following response fields:

result

• Description: The result is a string that contains the output generated by the Stealth Engine. This output is the stealthy content you requested, either generated from scratch or rephrased from the input provided.

• Type: String

• Example: "Your stealthy content goes here..."

howLikelyToBeDetected

• Description: The howLikelyToBeDetected is a score between 1 and 100, where 1 represents AI-detected content, and 100 indicates stealthy content that is undetectable as AI-generated. If the score is above 25, we recommend alerting the user to retry their prompt, as the generated content may not be stealthy enough. In such cases, using the stealthy output as a new input instead of the original prompt may yield better results.

• Type: Integer

• Example: 90

systemTokensSpent

• Description: The systemTokensSpent field indicates the number of tokens used by the system for generating the response. This helps users keep track of their usage and understand the system's token consumption.

• Type: Integer

• Example: 50

tokensSpent

• Description: The tokensSpent field indicates the number of tokens used for generating that response. This helps users keep track of their usage, manage their token budget effectively, and prevent abuse.

• Type: Integer

• Example: 707

totalTokensSpent

• Description: The totalTokensSpent field represents the total number of tokens spent, including both the system tokens and the user's tokens.

• Type: Integer

• Example: 757

remainingCredits

• Description: The remainingCredits displays the number of credits left in the API user's balance. This allows users to keep track of their API usage and manage their available credits effectively.

• Type: Integer

• Example: 5000

Example of a Typical /stealthify API Response

{
    "result": "Your stealthy content goes here...",
    "howLikelyToBeDetected": 90,
    "systemTokensSpent": 50,
    "tokensSpent": 707,
    "totalTokensSpent": 757,
    "remainingCredits": 5000
}

/stealthify/articles Endpoint

The /stealthify/articles endpoint provides the following response fields:

result

• Description: The result is a string that contains the output generated by the Stealth Engine in markdown format. This output is the content you requested, formatted as markdown.

• Type: String

• Example: "markdown string"

remainingCredits

• Description: The remainingCredits displays the number of credits left in the API user's balance. This allows users to keep track of their API usage and manage their available credits effectively.

• Type: Integer

• Example: 5000

Example of a Typical /stealthify/articles API Response

{
    "result": "markdown string",
    "remainingCredits": 5000
}