Skip to content
Ishvana Ishvana Docs

List Suggestions

GET
/api/creative/edit/suggestions/{session_id}

Get all suggestions for an edit session.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
session_id
required
Session Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response List Suggestions Api Creative Edit Suggestions Session Id Get
Array<object>
EditSuggestion

A single edit suggestion with precise location and rationale.

object
id
required
Id

Unique suggestion ID

string
documentId
required
Documentid

Document this suggestion applies to

string
suggestionType
required
EditSuggestionType

Category of edit

string
Allowed values: grammar phrasing consistency style_guide tone pacing dialogue
severity
required
EditSeverity

How important this edit is

string
Allowed values: error warning suggestion
status
required
SuggestionStatus

Current status

string
Allowed values: pending accepted rejected modified
paragraphIndex
required
Paragraphindex

0-based paragraph index

integer
sentenceIndex
required
Sentenceindex

0-based sentence index within paragraph

integer
charOffsetStart
required
Charoffsetstart

Character offset start (authoritative)

integer
charOffsetEnd
required
Charoffsetend

Character offset end (authoritative)

integer
originalText
required
Originaltext

Text as it currently appears

string
suggestedText
required
Suggestedtext

Suggested replacement text

string
rationale
required
Rationale

Why this edit is suggested

string
styleGuideRule
Any of:
string
createdAt
required
Createdat

Unix timestamp

integer

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object