Gerri API

Schemas

RedlineEvaluation

idstring · uuid · required
commentarystring · required
created_atstring · date-time · required
evaluationstring · required
Outcome for this redline (e.g. accept, needs_review)
redline_idstring · uuid · required
redline_review_idstring · uuid · required
relevant_rule_topicsstring[] · required
updated_atstring · date-time · required

rejection_commentstring | null

ReviewDownloadAuditUnsupportedMessage

messagestring · required

ReviewDownloadProcessedUnsupportedMessage

messagestring · required

ReviewDownloadZipUnsupportedError

errorstring · required

TopicbookRuleMetadata

idstring · uuid · required
namestring · required
questionsstring · required
Rule topic questions used to guide the summary position.

SummaryPosition

idstring · uuid · required
created_atstring · date-time · required
detailed_explanationstring · required
document_referencesstring[] · required
summarystring · required
summary_review_idstring · uuid · required
topicbook_rule_metadataobject · required
updated_atstring · date-time · required

SummaryReviewFlagViolation

idstring · uuid · required
decisionstring · enum · required
Recorded outcome for this flag violation.
Enum values:
exception_approved
issue_confirmed
created_atstring · date-time · required
document_referencesstring[] · required
reasoningstring · required
remedy_suggestedstring · required
reviewerstring · email · required
Email of the reviewer who recorded the decision.
rulestring · required
Playbook rule text or summary that was evaluated.
summary_review_flag_idstring · uuid · required
summary_review_idstring · uuid · required
updated_atstring · date-time · required

RedlineReviewAttributes

review_typestring · const · required
Redline (diff) review with per-redline evaluations.
Const value: RedlineReview
redline_evaluationsobject[] · required

SummaryReviewAttributes

review_typestring · const · required
Summary review with topic positions and optional flag violations.
Const value: SummaryReview
summary_positionsobject[] · required

flag_violationsobject[]
Optional playbook flag issues detected for this summary review.

RedlineReviewListAttributes

review_typestring · const · required
Redline (diff) review. redline_evaluations are omitted on GET /v1/reviews; use GET /v1/reviews/{id}.
Const value: RedlineReview

SummaryReviewListAttributes

review_typestring · const · required
Summary review. summary_positions and flag_violations are omitted on GET /v1/reviews; use GET /v1/reviews/{id}.
Const value: SummaryReview

ReviewAttributesList

review_typestring · const · required
Redline (diff) review. redline_evaluations are omitted on GET /v1/reviews; use GET /v1/reviews/{id}.
Const value: RedlineReview

review_typestring · const · required
Summary review. summary_positions and flag_violations are omitted on GET /v1/reviews; use GET /v1/reviews/{id}.
Const value: SummaryReview

ReviewAttributes

review_typestring · const · required
Redline (diff) review with per-redline evaluations.
Const value: RedlineReview
redline_evaluationsobject[] · required

review_typestring · const · required
Summary review with topic positions and optional flag violations.
Const value: SummaryReview
summary_positionsobject[] · required

flag_violationsobject[]
Optional playbook flag issues detected for this summary review.

ReviewResource

idstring · uuid · required
typestring · enum · required
Enum values:
review
attributesobject · required

ReviewResourceList

idstring · uuid · required
typestring · enum · required
Enum values:
review
attributesobject · required

ReviewResponse

dataobject · required

ReviewsPagination

currentinteger · min: 1 · required
Current page number.
lastinteger · min: 1 · required
Last page number.
recordsinteger · required
Total number of reviews across all pages.

nextinteger | null
Next page number, or null when the current page is the last page.

ReviewsListMeta

paginationobject · required

ReviewsListLinks

selfstring · uri · required
Collection URL without pagination query parameters.
currentstring · uri · required
URL for the current page (includes page[number]).
laststring · uri · required
URL for the last page.

nextstring | null · uri
URL for the next page, or null when there is no next page.

ReviewsListResponse

dataobject[] · required
metaobject · required
linksobject · required

RedlineEvaluationsListResponse

dataobject[] · required
Redline evaluations for the review (same objects as attributes.redline_evaluations on a RedlineReview resource).

RedlineEvaluationResponse

dataobject · required

CounterproposalResourceDataAttributes

directivestring | null · required
Instruction-style input from the client counterpropose request, or null.
suggested_counterproposal_textstring | null · required
Gerri-generated suggested counterproposal text, or null.
created_atstring · date-time · required
updated_atstring · date-time · required
statusstring · enum · required
Processing state of the counterproposal.
Enum values:
completed
in_progress

PatchRedlineEvaluationAcceptAction

typestring · const · required
Accept this redline evaluation.
Const value: accept

PatchRedlineEvaluationRejectAction

typestring · const · required
Reject this redline evaluation.
Const value: reject

PatchRedlineEvaluationManualAction

typestring · const · required
Mark outcome as manual handling.
Const value: manual

PatchRedlineEvaluationNeedsReviewAction

typestring · const · required
Flag this evaluation as needing further review.
Const value: needs_review

PatchRedlineEvaluationCounterproposeAction

typestring · const · required
Submit a counterproposal for this redline.
Const value: counterpropose
counterproposalrequired
Exactly one shape: an object with required string directive (instructional text), or an object with required string new_text (replacement copy). additionalProperties is false on each branch—do not send both keys.

PatchRedlineEvaluationBody

evaluationrequired
Outcome and payload for this redline evaluation. Discriminated by type; see oneOf variants below.

commentstring
Optional comment accompanying the evaluation update.

FlagViolationsListResponse

dataobject[] · required
Flag violations for the review (same objects as attributes.flag_violations on a SummaryReview resource).

FlagViolationResponse

dataobject · required

PatchFlagViolationBody

decisionstring · enum · required
User decision for this flag violation.
Enum values:
exception_approved
issue_confirmed

OrganizationResource

idstring · uuid · required
Organization id (same as attributes id).
typestring · enum · required
Enum values:
organization
attributesobject · required

OrganizationResponse

dataobject · required

PatchOrganizationBody

namestring · minLength: 1
New name for the organization. Omit this field to leave the name unchanged; if sent, the value must be a non-empty string.
default_reviewer_idstring · uuid · minLength: 1 · pattern: ^[0-9a-fA-F]{8}-[0-9…
User id of the new default reviewer; must be an available reviewer for the organization. Omit this field to leave the reviewer unchanged; if sent, the value must be a canonical UUID string (8-4-4-4-12 hex digits).

PlaybookResource

idstring · uuid · required
typestring · enum · required
Enum values:
playbook
attributesobject · required

PlaybooksListResponse

dataobject[] · required

PlaybookResponse

dataobject · required

PatchPlaybookBody

namestring
New name for the playbook.
descriptionstring
New description for the playbook.

CreatePlaybookBody

namestring · required
Name for the new playbook.

descriptionstring
Optional description for the new playbook.

PlaybookRule

idstring · uuid · required
typestring · enum · required
Enum values:
playbook_rule
attributesobject · required

PlaybookRuleResponse

dataobject · required

PlaybookRulesListResponse

dataobject[] · required

CreatePlaybookRuleBody

namestring · required
Name for the rule.
actionsstring · required
Actions to take when this rule is triggered.

descriptionstring
Optional description for the rule.

PatchPlaybookRuleBody

namestring
Updated name for the rule.
descriptionstring
Updated description for the rule.
actionsstring
Updated actions for the rule.

ApiErrorResponse

errorstring · required
Human-readable error message.

InvitationResource

idstring · uuid · required
typestring · enum · required
Enum values:
invitation
attributesobject · required

InvitationsListResponse

dataobject[] · required

InvitationResponse

dataobject · required

CreateInvitationBody

emailstring · email · required
Address to invite; must not already belong to a member of the organization.

namestring
Optional display name when a new user record is created for this email.

RedlineEvaluation

idstring · uuid · required
commentarystring · required
created_atstring · date-time · required
evaluationstring · required
Outcome for this redline (e.g. accept, needs_review)
redline_idstring · uuid · required
redline_review_idstring · uuid · required
relevant_rule_topicsstring[] · required
updated_atstring · date-time · required

rejection_commentstring | null

SummaryPosition

idstring · uuid · required
created_atstring · date-time · required
detailed_explanationstring · required
document_referencesstring[] · required
summarystring · required
summary_review_idstring · uuid · required
topicbook_rule_metadataobject · required
updated_atstring · date-time · required

SummaryReviewFlagViolation

idstring · uuid · required
decisionstring · enum · required
Recorded outcome for this flag violation.
Enum values:
exception_approved
issue_confirmed
created_atstring · date-time · required
document_referencesstring[] · required
reasoningstring · required
remedy_suggestedstring · required
reviewerstring · email · required
Email of the reviewer who recorded the decision.
rulestring · required
Playbook rule text or summary that was evaluated.
summary_review_flag_idstring · uuid · required
summary_review_idstring · uuid · required
updated_atstring · date-time · required

ReviewAttributesList

review_typestring · const · required
Redline (diff) review. redline_evaluations are omitted on GET /v1/reviews; use GET /v1/reviews/{id}.
Const value: RedlineReview

review_typestring · const · required
Summary review. summary_positions and flag_violations are omitted on GET /v1/reviews; use GET /v1/reviews/{id}.
Const value: SummaryReview

ReviewAttributes

review_typestring · const · required
Redline (diff) review with per-redline evaluations.
Const value: RedlineReview
redline_evaluationsobject[] · required

review_typestring · const · required
Summary review with topic positions and optional flag violations.
Const value: SummaryReview
summary_positionsobject[] · required

flag_violationsobject[]
Optional playbook flag issues detected for this summary review.

ReviewsListLinks

selfstring · uri · required
Collection URL without pagination query parameters.
currentstring · uri · required
URL for the current page (includes page[number]).
laststring · uri · required
URL for the last page.

nextstring | null · uri
URL for the next page, or null when there is no next page.

CounterproposalResourceDataAttributes

directivestring | null · required
Instruction-style input from the client counterpropose request, or null.
suggested_counterproposal_textstring | null · required
Gerri-generated suggested counterproposal text, or null.
created_atstring · date-time · required
updated_atstring · date-time · required
statusstring · enum · required
Processing state of the counterproposal.
Enum values:
completed
in_progress

PatchRedlineEvaluationCounterproposeAction

typestring · const · required
Submit a counterproposal for this redline.
Const value: counterpropose
counterproposalrequired
Exactly one shape: an object with required string directive (instructional text), or an object with required string new_text (replacement copy). additionalProperties is false on each branch—do not send both keys.

PatchOrganizationBody

namestring · minLength: 1
New name for the organization. Omit this field to leave the name unchanged; if sent, the value must be a non-empty string.
default_reviewer_idstring · uuid · minLength: 1 · pattern: ^[0-9a-fA-F]{8}-[0-9…
User id of the new default reviewer; must be an available reviewer for the organization. Omit this field to leave the reviewer unchanged; if sent, the value must be a canonical UUID string (8-4-4-4-12 hex digits).