Skip to main content
POST
Generate Text

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

A bearer authorization header containing a Risk Cloud API access token in the format Authorization: Bearer {TOKEN}.

To obtain a Risk Cloud API access token, refer to Obtain an API Access Token in the LogicGate Help Center.

Query Parameters

workflow-id
string

Body

application/json
message
string
required

The prompt input for the OpenAI model.

Minimum string length: 1
Example:

"The email body text of a concise and kind business notification to a recipient to fill out a cyber risk evaluation. No subject."

maxOutputTokens
integer<int32>

An upper bound for the number of tokens that can be generated.

Required range: x >= 0
Example:

100

temperature
number<double>

The sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

Required range: 0 <= x <= 2
Example:

1

Response

200 - application/json

OK

id
string
required

The unique ID of this Risk Cloud resource

Example:

"a1b2c3d4"

name
string
required

The name of the field

Example:

"Risk Severity"

application
Application (Property) · object
required

The parent application of the field, or null for global fields

workflow
Workflow (Property) · object
required

The parent workflow of the field, or null for global fields

label
string
required

The label of the field as shown on the record

Example:

"Enter the Risk Severity based on your assessment"

global
boolean
required

Whether the field is global

Example:

false

required
boolean
required

Whether the field is required for the current step

Example:

false

tooltip
string
required

The tooltip information of the field

Example:

"Select the Risk Severity"

helpText
string
required

The help text of the field to supply necessary context for filling out the field

Example:

"Determine the Risk Severity from your assessment"

type
enum<string>
required

The type of the field

Available options:
DATE,
USER,
EXTERNAL_USER,
TEXT,
TEXT_AREA,
NUMBER,
E_SIGNATURE,
CHECKBOX,
MULTI_SELECT,
RADIO,
SELECT,
ATTACHMENT,
CALCULATION,
TEXT_CONCATENATION,
LINKED_RECORDS_COUNT,
DATE_CALCULATION,
OTHER
Example:

"SELECT"

valueType
enum<string>
required

The type of the field value

Available options:
NUMBER,
CALCULATION,
ATTACHMENT,
DATE,
OPTION,
USER,
TEXT,
OTHER
Example:

"OPTION"

optionValues
Value (Property) · object[]
required

The option values of the field for Select, Multi-Select, Radio, Checkbox, and E-Signature field types

defaultValues
Value (Property) · object[]
required

The default values of the field

pattern
string
required

The regular expression used to validate field input.

Example:

"[0-9]{3}-[0-9]{3}-[0-9]{4}$"

message
string
required

The text that displays in a Field when no value has been input yet.

expression
string
required

The mathematical expression used to calculate a value for a Calculation Field.

Example:

"%f + %f"

nullStrategy
string
required

The way in which null values are handled for a calculation.

Example:

"Available options are: null, 0, 1, N/A, a blank space, and an empty String."

logicalHandling
enum<string>
required

The comparison operator used to define label range boundaries for a calculation field. Determines whether ranges are created for values greater than or less than the baseline number.

Available options:
EQUALS,
NOT_EQUALS,
IS,
IS_NOT,
GREATER_THAN,
GREATER_THAN_EQUALS,
LESS_THAN,
LESS_THAN_EQUALS,
CONTAINS,
DOES_NOT_CONTAIN,
NULL,
NOT_NULL,
DATE_RANGE,
NUMERIC_RANGE
Example:

"Some examples are: EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_EQUALS, etc."

labelsEnabled
boolean
required

A true or false describing if labels are enabled.

Example:

true

fieldInputs
object[]
required

The Fields that are used by a calculation as input.

The number of relationship hops from the source Record that the Linked Records Count calculation counts. Value between 1 and 10.

object
string
required

Identifies the type of object this data represents

Example:

"field"