> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/rightrev-rest-api/period-close/manual-journals.md).
# Manual Journals
## Get Manual Journal List
> To retrieve the list of all Manual Journal Batches created in the system.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/mje/v1/batches":{"get":{"description":"To retrieve the list of all Manual Journal Batches created in the system.\n","parameters":[{"name":"page","in":"path","required":false,"schema":{"type":"string","title":"page"},"description":"This is optional field. Page represents page number of the policy list.\n"},{"name":"page_size","in":"path","required":false,"schema":{"type":"string","title":"page_size"},"description":"This is optional field. Page size represents how many records available on each page.\n"}],"responses":{"200":{"description":"Get Manual Journal Runs","content":{"application/json":{"schema":{"type":"object","properties":{"batches":{"type":"array","items":{"type":"object","properties":{"approved_hold_id":{"type":"null","description":"This field contains value as null"},"batch_name":{"type":"string","description":"Name of the Manual Journal Batch."},"created_at":{"type":"integer","description":" Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"created_period":{"type":"string","description":"Month and year of the Manual Journal created. For e.g. Jan-2026"},"date_format":{"type":"null","description":"Format of Manual Journal Date. For e.g. MM/DD/YYYY"},"file_format":{"type":"string","description":"Type of file to be uploaded. For e.g. CSV"},"file_id":{"type":"string","description":"A system generated alpha-numeric number."},"file_location":{"type":"null","description":"This field contains value as null"},"file_name":{"type":"string","description":"Name of the file uploaded."},"file_size":{"type":"integer","description":"Size of the file uploaded. for e.g. 330kb"},"functional_currency":{"type":"string","description":"Functional currency of the Manual Journal created."},"legal_entity":{"type":"string","description":"Name of the Legal Entity in which Manual Journal is created."},"mje_id":{"type":"string","description":"Batch ID of the Manual Journal created. This is system generated value."},"mje_type":{"type":"string","description":"Type of the manual journal created. Either **Waterfall** or **Standard**."},"rc_action_at":{"type":"null","description":"This field contains value as null"},"rc_action_by":{"type":"null","description":"This field contains value as null"},"rc_id":{"type":["null","string"],"description":"Manual Journal Revenue Contract ID."},"rc_initiated_at":{"type":"null","description":"This field contains value as null"},"rc_initiated_by":{"type":"null","description":"This field contains value as null"},"reject_event_id":{"type":"null","description":"This field contains value as null"},"reject_hold_id":{"type":"null","description":"This field contains value as null"},"status":{"type":"string","description":"Status of Manual Journal Revenue Contract ID. For e.g mje_rc_created or file_uploaded_with_error "},"tenant_id":{"type":"string","description":"Tenant ID in which Manual Journal is created"},"total_rows_failed":{"type":"null","description":"Count of rows failed validation during processing of Manual Journal File."},"total_rows_processed":{"type":"integer","description":"Count of rows processed successfully during processing of Manual Journal File."},"total_rows_received":{"type":"integer","description":"Count of total rows uploaded for collection in Manual Journal File."},"user_comments":{"type":["null","string"],"description":"Any comments added by the user the time of creation of Manual Journal."}},"required":["approved_hold_id","batch_name","created_at","created_by","created_period","date_format","file_format","file_id","file_location","file_name","file_size","functional_currency","legal_entity","mje_id","mje_type","rc_action_at","rc_action_by","rc_id","rc_initiated_at","rc_initiated_by","reject_event_id","reject_hold_id","status","tenant_id","total_rows_failed","total_rows_processed","total_rows_received","user_comments"]},"description":"This will display details of Manual Journal Batches."},"total_records":{"type":"integer","description":"This will display count of total Manual Journal records"}},"required":["batches","total_records"]}}}}},"tags":["Manual Journals"],"summary":"Get Manual Journal List","operationId":"get_manual_journal_list_apis_mje_v1_batches_get"}}}}
```
## Get Manual Journal Action
> This API is used to retrieve of MJE Batch ID details.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/mje/v1/batches/{action}":{"get":{"description":"This API is used to retrieve of MJE Batch ID details.\n","parameters":[{"name":"action","in":"path","required":true,"schema":{"type":"string","title":"MJE Batch Id"},"description":"Provide MJE Batch ID in action field.\n"}],"responses":{"200":{"description":"get all mje details.","content":{"application/json":{"schema":{"type":"object","properties":{"approved_hold_id":{"type":"null","description":"ID of the approval hold applied to this MJE"},"batch_name":{"type":"string","description":"Name of the MJE Batch"},"created_at":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"created_period":{"type":"string","description":"Name of the period in which MJE is created."},"date_format":{"type":"null","description":"Format used for dates in the uploaded file. For e.g. MM/DD/YYYY"},"file_format":{"type":"string","description":"Format of the uploaded file (e.g., CSV, XLSX)."},"file_id":{"type":"string","description":"System-generated ID of the uploaded file."},"file_location":{"type":"null","description":"Storage path where the file is stored. Value will be null"},"file_name":{"type":"string","description":"Name of the uploaded file."},"file_size":{"type":"integer","description":"Size of the file in bytes."},"functional_currency":{"type":"string","description":"Currency codes used for the MJE amounts."},"legal_entity":{"type":"string","description":"Legal entity associated with the MJE."},"mje_id":{"type":"string","description":"System-generated unique MJE batch identifier."},"mje_type":{"type":"string","description":"Type of MJE (e.g., Standard or Waterfall)."},"rc_action_at":{"type":"null","description":"Timestamp when the reviewer took an action. Value will be null"},"rc_action_by":{"type":"null","description":"ID of the User who performed the reviewer action. Value will be null"},"rc_id":{"type":"string","description":"Revenue Contract ID of the MJE"},"rc_initiated_at":{"type":"null","description":"Timestamp when the RC initiated. Value will be null"},"rc_initiated_by":{"type":"null","description":"ID of the User who initiated action. Value will be null"},"reject_event_id":{"type":"null","description":"ID for rejection event (if MJE was rejected)."},"reject_hold_id":{"type":"null","description":"Hold ID applied during rejection"},"status":{"type":"string","description":"Current status of the MJE workflow. For e.g. File uploaded or MJE Approved"},"tenant_id":{"type":"string","description":"Tenant/environment identifier."},"total_rows_failed":{"type":"null","description":"Number of rows in the uploaded file that failed validation."},"total_rows_processed":{"type":"integer","description":"Number of rows in the uploaded file that processed successfully."},"total_rows_received":{"type":"integer","description":"Total number of rows uploaded in the file."},"user_comments":{"type":"null","description":"Comments provided by the user for this MJE."}},"required":["approved_hold_id","batch_name","created_at","created_by","created_period","date_format","file_format","file_id","file_location","file_name","file_size","functional_currency","legal_entity","mje_id","mje_type","rc_action_at","rc_action_by","rc_id","rc_initiated_at","rc_initiated_by","reject_event_id","reject_hold_id","status","tenant_id","total_rows_failed","total_rows_processed","total_rows_received","user_comments"]}}}}},"tags":["Manual Journals"],"summary":"Get Manual Journal Action","operationId":"get_manual_journal_action_apis_mje_v1_batches__action__get"}}}}
```
## Manual Journal Template
> This API is used to download the Standard Templates of \*\*Standard\*\* Or \*\*Waterfall\*\* Manual Journal.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/mje/v1/{mje_type}/template":{"get":{"description":"This API is used to download the Standard Templates of **Standard** Or **Waterfall** Manual Journal.\n","parameters":[{"name":"mje_type","in":"path","required":true,"schema":{"type":"string","title":"Mje Type"},"description":"User need to provide the Manual Journal Type they want to download. Supported values are **standard** or **waterfall**. The standard templates are attached below.\n"}],"responses":{"200":{"description":"Get Journal Template - In Raw text, columns seperated by commas","content":{"text/csv":null,"application/json":{"schema":{}}}}},"tags":["Manual Journals"],"summary":"Manual Journal Template","operationId":"manual_journal_template_apis_mje_v1__mje_type__template_get"}}}}
```
## Manual Journal Download
> This API is used to download the uploaded Manual journal file.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/mje/v1/batches/{file_id}/download":{"get":{"description":"This API is used to download the uploaded Manual journal file.\n","parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"},"description":"A system generated alpha-numeric number at the time of uploading file.\n"}],"responses":{"200":{"description":"Manual Journal Download","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}}},"tags":["Manual Journals"],"summary":"Manual Journal Download","operationId":"manual_journal_download_apis_mje_v1_batches__file_id__download_get"}}}}
```
## Post Manual Journal Action
> This API is used to create Manual Journal through csv file upload.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/mje/v1/batches/{action}":{"post":{"description":"This API is used to create Manual Journal through csv file upload.\n","responses":{"200":{"description":"post mje","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","description":"A system generated alpha-numeric number."},"message":{"type":"string","description":"A message generated on csv file upload."}},"required":["file_id","message"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"file","format":"binary","description":"The CSV file to be uploaded to the system. Refer a [Sample CSV File] TODO"},"batch_name":{"type":"text","format":"string","description":"Name of the Manual Journal Batch."},"date_format":{"type":"text","format":"%m/%d/%Y","description":"Date format of Manual Journal."},"legal_entity":{"type":"text","format":"string","description":"Legal Entity in which user is creating Manual Journal"},"mje_type":{"type":"text","format":"string","description":"Type of the Manual Journal. Either **STANDARD** or **WATERFALL**."},"functional_currency":{"type":"text","format":"string","description":"Functional Currency of the Manual Journal."}},"required":["file","batch_name","legal_entity","mje_type","functional_currency"]}},"application/json":{"schema":{}}},"required":true},"tags":["Manual Journals"],"summary":"Post Manual Journal Action","operationId":"post_manual_journal_action_apis_mje_v1_batches__action__post"}}}}
```
## Manual Journal Approve Reject
> This API is used to \*\*Approve\*\* or \*\*Reject\*\* the manual journal.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/mje/v1/batches/{mje_id}/{action}":{"put":{"description":"This API is used to **Approve** or **Reject** the manual journal.\n","parameters":[{"name":"mje_id","in":"path","required":true,"schema":{"type":"string","title":"Mje Id"},"description":"Manual Journal ID.\n"},{"name":"action","in":"path","required":true,"schema":{"type":"string","title":"Action"},"description":"Supported actions are **approve** or **reject**.\n"}],"responses":{"200":{"description":"This API is used to **Approve** or **Reject** the manual journal.","content":{"application/json":{"schema":{"type":"object","properties":{"current_timestamp":{"type":"string","description":"Timestamp of the approve or reject action initiated by the user. This is a unix Epoch timestamp format."},"hold_details":{"type":"array","items":{"type":"object","properties":{"applied_by":{"type":"string","description":"ID of the user who rejected Manual Journal."},"applied_on":{"type":"string","description":"Timestamp of manual journal rejected. This is a unix Epoch timestamp format."},"hold_activity":{"type":"string","description":"Details of the hold activity. If Manual Journal is approved it will show RELEASE and if rejected it will show HOLD."},"hold_name":{"type":"string","description":"Name of the hold"},"hold_type":{"type":"string","description":"Type of the hold."},"message":{"type":"string","description":"A message genereted on action initiated."},"mje_id":{"type":"string","description":"Manual journal ID"},"released_by":{"type":"string","description":"ID of the user who approved."},"released_on":{"type":"string","description":"Timestamp of manual journal approved. This is a unix Epoch timestamp format."},"revenue_contract_id":{"type":"string","description":"Manual Journal Revenue Contract ID."},"user_comments":{"type":"string","description":"Any comments added by the user at the time of approve or reject Manual Journal."}},"required":["applied_by","applied_on","hold_activity","hold_name","hold_type","message","mje_id","released_by","released_on","revenue_contract_id","user_comments"]},"description":"Details of hold."},"user_name":{"type":"string","description":"ID of the user. This action will be done at engine side. So , ID of the user will always be RIGHTREV."}},"required":["current_timestamp","hold_details","user_name"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_name":{"type":"string","description":"ID of the user who is approving or rejecting the Manual Journal."},"user_comments":{"type":"string","description":"Any comments added by the user at the time of approve or reject Manual Journal."}},"required":["user_comments","user_name"]}}},"required":true},"tags":["Manual Journals"],"summary":"Manual Journal Approve Reject","operationId":"manual_journal_approve_reject_apis_mje_v1_batches__mje_id___action__put"}}}}
```
## Get Supporting Docs List
> \- This API is to retrieve the file details of supporting document uploaded in Revenue Contract or Manual journal Entry.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/supporting_doc/v1/lov/{doc_type}/{doc_id}":{"get":{"parameters":[{"name":"doc_type","in":"path","required":true,"schema":{"type":"string","title":"Doc Type"},"description":"This is the type of document. User can provide RC or MJE to fetch the supporting document details.\n"},{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","title":"Doc Id"},"description":"This is number of revenue contract or manual journal entry.\n"}],"responses":{"200":{"description":"Get Supporting document list","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"file_name":{"type":"string","description":"Name and type of the file uploaded as supporting document."},"file_size":{"type":"number","description":"Size of the supporting document file uploaded."},"last_modified":{"type":"string","description":"Timestamp of the policy last modified on. This is a unix Epoch timestamp format."},"user_name":{"type":"string","description":"Name of the user who uploaded supporting document file."},"doc_type":{"type":"string","description":"Type of the document uploaded for. Is it supporting document for RC or MJE."},"doc_id":{"type":"string","description":"Revenue contract or MJE number."}},"required":["doc_id","doc_type","file_name","file_size","last_modified","user_name"]}}}}}},"description":"- This API is to retrieve the file details of supporting document uploaded in Revenue Contract or Manual journal Entry.\n","tags":["Supporting Docs"],"summary":"Get Supporting Docs List","operationId":"get_supporting_docs_list_apis_supporting_doc_v1_lov__doc_type___doc_id__get"}}}}
```
## Upload Supporting Doc
> \- This API is to upload the supporting document file in Revenue Contract or Manual journal Entry. \
> \- User can upload multiple type of files - pdf, doc, docx, xls, xlsx, txt, rtf, odt, ods, csv, html, htm, md, xml, jpg, jpeg, png.\
> \- The Supporting Documents feature is available only to users with the Sysadmin and Revenue Manager roles.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/supporting_doc/v1/":{"post":{"responses":{"200":{"description":"Upload Supporting document","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"System generated message on file upload."}},"required":["message"]}}}}},"description":"- This API is to upload the supporting document file in Revenue Contract or Manual journal Entry. \n- User can upload multiple type of files - pdf, doc, docx, xls, xlsx, txt, rtf, odt, ods, csv, html, htm, md, xml, jpg, jpeg, png.\n- The Supporting Documents feature is available only to users with the Sysadmin and Revenue Manager roles.\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"file","format":"binary","description":"Attach Supporting document file."}},"required":["file"]}}},"required":true},"tags":["Supporting Docs"],"summary":"Upload Supporting Doc","operationId":"upload_supporting_doc_apis_supporting_doc_v1__post"}}}}
```
## Download Supporting Doc
> \- This API is to retrieve the supporting document file uploaded in Revenue Contract or Manual journal Entry.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name}":{"get":{"parameters":[{"name":"doc_type","in":"path","required":true,"schema":{"type":"string","title":"Doc Type"},"description":"This is type of document. User can provide RC or MJE to fetch the supporting document details.\n"},{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","title":"Doc Id"},"description":"This is number of revenue contract or manual journal entry.\n"},{"name":"file_name","in":"path","required":true,"schema":{"type":"string","title":"File Name"},"description":"This is the name of supporting document file user want to download.\n"}],"responses":{"200":{"description":"Download Supporting document","content":{"application/json":{"schema":{}}}}},"description":"- This API is to retrieve the supporting document file uploaded in Revenue Contract or Manual journal Entry.\n","tags":["Supporting Docs"],"summary":"Download Supporting Doc","operationId":"download_supporting_doc_apis_supporting_doc_v1__doc_type___doc_id___file_name__get"}}}}
```
## Delete Supporting Doc
> \- This API is to delete the supporting document uploaded in Revenue Contract or Manual journal Entry.\
> \- Only the file owner (the user who uploaded the file) can delete their own files.
```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name}":{"delete":{"parameters":[{"name":"doc_type","in":"path","required":true,"schema":{"type":"string","title":"Doc Type"},"description":"This is type of document. User can provide RC or MJE to fetch the supporting document details.\n"},{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","title":"Doc Id"},"description":"This is number of revenue contract or manual journal entry. \n"},{"name":"file_name","in":"path","required":true,"schema":{"type":"string","title":"File Name"},"description":"This is the name of supporting document file user want to delete.\n"}],"responses":{"200":{"description":"Delete Supporting document","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Display system generates message on delete action."}},"required":["message"]}}}}},"description":"- This API is to delete the supporting document uploaded in Revenue Contract or Manual journal Entry.\n- Only the file owner (the user who uploaded the file) can delete their own files.\n","tags":["Supporting Docs"],"summary":"Delete Supporting Doc","operationId":"delete_supporting_doc_apis_supporting_doc_v1__doc_type___doc_id___file_name__delete"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://apis.rightrev.com/rightrev-rest-api/period-close/manual-journals.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.