POST

https://api.{environment}.corti.app/v2/

/
interactions
/
{id}
/
documents

Path Parameters

​
id
string
required

The interaction ID representing the context for the request.

Query Parameters

​
stream
boolean

If true the response happens via SSE sending back a full valid JSON always, however, the content within text may be incomplete.

Body

application/json
​
context
object[]
required

An array of context objects.

​
templateId
string
required

The ID of the template that informs on what kind of document is to be generated.

​
templateKey
string
required

The key of the template that informs on what kind of document is to be generated.

​
outputLanguage
string
required

The language in which the document will be generated. (BCP-47)

​
template
object

Template details if the template should be generated during the request. Overrides templateId.

​
name
string

An optional name for the document.

​
modelName
string

Response

201 - application/json
​
id
string
​
name
string
​
templateRef
string
​
isStream
boolean
​
sections
object[]

Was this page helpful?

List DocumentsGet Document