Skip to main content
POST
Suggest

Path Parameters

workspaceId
string
required
Pattern: ^[1-9]\d*$
projectId
string
required
Pattern: ^[1-9]\d*$

Body

application/json
itemId
string | null
required
Pattern: ^[1-9]\d*$
version
integer | null
required
Required range: 0 < x <= 9007199254740991
name
string
required
Maximum string length: 200
categoryId
string | null
required
Pattern: ^[1-9]\d*$
productTypeId
string | null
required
Pattern: ^[1-9]\d*$
columnsAttributes
object
required
clientTurnId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
draftRevision
integer
required
Required range: 0 <= x <= 9007199254740991
language
enum<string>
required
Available options:
en,
de,
es,
fr,
ja,
zh
dismissedFields
string[]
required
Maximum array length: 100
Maximum string length: 200
guidance
object[]
required
Maximum array length: 40
dismissedGuidance
enum<string>[]
required
Maximum array length: 2
Available options:
instruction,
requirement

Response

201 - application/json
status
enum<string>
required
Available options:
completed,
failed
draftRevision
number
required
runIds
string[]
required
errorCode
string
chargedCredits
string
identity
object | null
fields
object[]
guidance
object[]
guidanceRevision
number | null