POST 1.0/internal/ai/{siteprefix}/{siteid}/gettext

Description

Get the Text from the AI

URI Parameters
Name Description Type Additional information
sitePrefix

The Site Prefix to use

 string

Required
siteId

The Site ID to use

 integer

Required

The request containing the prompt

AITextRequest
Name Description Type Additional information
Prompt

string

None.

application/json, text/json
Sample: 
{
  "prompt": "sample string 1"
}

application/xml, text/xml
Sample: 
<AITextRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Prompt>sample string 1</Prompt>
</AITextRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

AITextResponse

AITextResponse
Name Description Type Additional information
Output

string

None.
CreditsRemaining

integer

None.

application/json, text/json
Sample: 
{
  "output": "sample string 1",
  "creditsRemaining": 2
}

application/xml, text/xml
Sample: 
<AITextResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CreditsRemaining>2</CreditsRemaining>
  <Output>sample string 1</Output>
</AITextResponse>