Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
mode
enum<string>
required

Use 'full' for end-to-end inference of a prompt.

Available options:
full
Example:

"full"

messages
object[]
required

Conversation history. Required when mode is 'full'.

Example:
model
string
required

ID of the fine-tuned model to use.

Example:

"ftm-custom-name-0b5ace7e-ffb2-43cf-8a4d-0af17bc2b1d1"

full_mode_options
object

Options specific to 'full' mode.

stream
boolean
default:false

Whether to stream the response.

Example:

false

include_quality
boolean
default:false

Whether to include quality metrics in the response.

Example:

false

include_rouge
boolean
default:false

Whether to include rouge score in quality metrics. Only applies when include_quality is true.

Example:

false

include_compare_original
boolean
default:false

Whether to include original text for comparison to styled text.

Example:

false

include_distance
boolean
default:false

Whether to include distance metrics comparing the original and styled text.

Example:

false

skip_headings
boolean
default:false

When set to true, headings are not rewritten.

Example:

false

skip_h1
boolean
default:false

When set to true, H1 headings are not rewritten.

Example:

false

Response

A chat completion object.

id
string

ID of the chat completion.

Example:

"chatcmpl-123"

object
string

Type of the object, always 'chat.completion'.

Example:

"chat.completion"

created
integer

Unix timestamp for when the completion was created.

Example:

1677652288

model
string

Model used for the completion.

Example:

"ftm-custom-name-0b5ace7e-ffb2-43cf-8a4d-0af17bc2b1d1"

choices
object[]
usage
object
quality_analytics
object

Quality analytics comparing the styled text against the input text and training data. Only present when include_quality is true.