Skip to content
Ishvana Ishvana Docs

Suggest Events From Document

POST
/api/creative/timelines/suggest-events-from-document

Suggest timeline events from a document’s text.

Request Body required

Section titled “Request Body required ”
EventSuggestionRequest

POST /timelines/suggest-events-from-document body.

object
documentId
required
Documentid

Document to analyze

string
timelineId
required
Timelineid

Target timeline

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

EventSuggestionResponse

Suggested events from a document.

object
status
required
Status

Operation status

string
data
required
Data

Event suggestions

Array<object>
EventSuggestion

Suggested timeline event derived from document text.

object
title
required
Title

Suggested event title

string
description
Description

Context from text

string
""
dateDisplay
required
Datedisplay

Extracted date string

string
suggestedSortKey
Any of:
integer
confidence
required
Confidence

Suggestion confidence

number
<= 1
sourceOffset
required
Sourceoffset

Character offset in source document

integer
alreadyExists
Alreadyexists

Whether a matching event exists

boolean

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