Update Report Plan

PATCH 
/api/v1/reports/:report_id/plan

Update the plan of a report, including approval, rejection, and editing.

Request

Path Parameters

report_id uuidrequired

Query Parameters

action Actionrequired

Possible values: [approve, reject, edit]

project_id any
organization_id any

Cookie Parameters

session any

application/json

Body

anyOf

ReportPlan

id uuid

The id of the report plan

blocks

object[]

The blocks of the report

Array [

block

object

required

idx Idx (integer)required

The index of the block

template Template (string)required

The content of the block

sources

object[]

The sources for the block

Array [

node

object

required

Provided for backward compatibility.

Note: we keep the field with the typo "seperator" to maintain backward compatibility for serialized objects.

id_ Id (string)

Unique ID of the node.

embedding

object

Embedding of the node.

anyOf

MOD1

Array [

number

]

extra_info object

A flat dictionary of metadata fields

excluded_embed_metadata_keys string[]

Metadata keys that are excluded from text for the embed model.

excluded_llm_metadata_keys string[]

Metadata keys that are excluded from text for the LLM.

relationships

object

A mapping of relationships to other node information.

property name*

object

anyOf

RelatedNodeInfo

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

MOD2

Array [

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

]

metadata_template Metadata Template (string)

Template for how metadata is formatted, with {key} and {value} placeholders.

Default value: {key}: {value}

metadata_separator Metadata Separator (string)

Separator between metadata fields when converting to string.

Default value:

text Text (string)

Text content of the node.

Default value:

mimetype Mimetype (string)

MIME type of the node content.

Default value: text/plain

start_char_idx

object

Start char index of the node.

anyOf

MOD1

integer

end_char_idx

object

End char index of the node.

anyOf

MOD1

integer

metadata_seperator Metadata Seperator (string)

Separator between metadata fields when converting to string.

Default value:

text_template Text Template (string)

Template for how text is formatted, with {content} and {metadata_str} placeholders.

Default value: {metadata_str} {content}

class_name Class Name (string)

Default value: TextNode

score

object

anyOf

MOD1

number

class_name Class Name (string)

Default value: TextNodeWithScore

]

queries

object[]

The queries for the block

Array [

field Field (string)required

The field in the template that needs to be filled in

prompt Prompt (string)required

The prompt for filling in the field

context Context (string)required

Any additional context for the query

]

dependency ReportBlockDependency (string)required

The dependency for the block

Possible values: [none, all, previous, next]

]

generated_at date-time

The timestamp of when the plan was generated

Responses

200

Successful Response

application/json

Schema

Schema

name Name (string)required
report_id uuidrequired

report

object

required

anyOf

Report

id uuidrequired

The id of the report

blocks

object[]

The blocks of the report

Array [

idx Idx (integer)required

The index of the block

template Template (string)required

The content of the block

sources

object[]

The sources for the block

Array [

node

object

required

Provided for backward compatibility.

Note: we keep the field with the typo "seperator" to maintain backward compatibility for serialized objects.

id_ Id (string)

Unique ID of the node.

embedding

object

Embedding of the node.

anyOf

MOD1

Array [

number

]

extra_info object

A flat dictionary of metadata fields

excluded_embed_metadata_keys string[]

Metadata keys that are excluded from text for the embed model.

excluded_llm_metadata_keys string[]

Metadata keys that are excluded from text for the LLM.

relationships

object

A mapping of relationships to other node information.

property name*

object

anyOf

RelatedNodeInfo

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

MOD2

Array [

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

]

metadata_template Metadata Template (string)

Template for how metadata is formatted, with {key} and {value} placeholders.

Default value: {key}: {value}

metadata_separator Metadata Separator (string)

Separator between metadata fields when converting to string.

Default value:

text Text (string)

Text content of the node.

Default value:

mimetype Mimetype (string)

MIME type of the node content.

Default value: text/plain

start_char_idx

object

Start char index of the node.

anyOf

MOD1

integer

end_char_idx

object

End char index of the node.

anyOf

MOD1

integer

metadata_seperator Metadata Seperator (string)

Separator between metadata fields when converting to string.

Default value:

text_template Text Template (string)

Template for how text is formatted, with {content} and {metadata_str} placeholders.

Default value: {metadata_str} {content}

class_name Class Name (string)

Default value: TextNode

score

object

anyOf

MOD1

number

class_name Class Name (string)

Default value: TextNodeWithScore

]

]

plan

object

required

anyOf

ReportPlan

id uuid

The id of the report plan

blocks

object[]

The blocks of the report

Array [

block

object

required

idx Idx (integer)required

The index of the block

template Template (string)required

The content of the block

sources

object[]

The sources for the block

Array [

node

object

required

Provided for backward compatibility.

Note: we keep the field with the typo "seperator" to maintain backward compatibility for serialized objects.

id_ Id (string)

Unique ID of the node.

embedding

object

Embedding of the node.

anyOf

MOD1

Array [

number

]

extra_info object

A flat dictionary of metadata fields

excluded_embed_metadata_keys string[]

Metadata keys that are excluded from text for the embed model.

excluded_llm_metadata_keys string[]

Metadata keys that are excluded from text for the LLM.

relationships

object

A mapping of relationships to other node information.

property name*

object

anyOf

RelatedNodeInfo

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

MOD2

Array [

node_id Node Id (string)required

node_type

object

anyOf

ObjectType

string

Possible values: [1, 2, 3, 4, 5]

MOD2

string

metadata object

hash

object

anyOf

MOD1

string

class_name Class Name (string)

Default value: RelatedNodeInfo

]

metadata_template Metadata Template (string)

Template for how metadata is formatted, with {key} and {value} placeholders.

Default value: {key}: {value}

metadata_separator Metadata Separator (string)

Separator between metadata fields when converting to string.

Default value:

text Text (string)

Text content of the node.

Default value:

mimetype Mimetype (string)

MIME type of the node content.

Default value: text/plain

start_char_idx

object

Start char index of the node.

anyOf

MOD1

integer

end_char_idx

object

End char index of the node.

anyOf

MOD1

integer

metadata_seperator Metadata Seperator (string)

Separator between metadata fields when converting to string.

Default value:

text_template Text Template (string)

Template for how text is formatted, with {content} and {metadata_str} placeholders.

Default value: {metadata_str} {content}

class_name Class Name (string)

Default value: TextNode

score

object

anyOf

MOD1

number

class_name Class Name (string)

Default value: TextNodeWithScore

]

queries

object[]

The queries for the block

Array [

field Field (string)required

The field in the template that needs to be filled in

prompt Prompt (string)required

The prompt for filling in the field

context Context (string)required

Any additional context for the query

]

dependency ReportBlockDependency (string)required

The dependency for the block

Possible values: [none, all, previous, next]

]

generated_at date-time

The timestamp of when the plan was generated

version Version (integer)required
last_updated date-timerequired
status ReportState (string)required

Possible values: [pending, planning, waiting_approval, generating, completed, error]

total_versions Total Versions (integer)required

Example (from schema)

{
  "name": "string",
  "report_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "report": {},
  "plan": {},
  "version": 0,
  "last_updated": "2024-07-29T15:51:28.071Z",
  "status": "pending",
  "total_versions": 0
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}