GCgc-ai
Contract Intelligence

Set a cell value by hand

Overwrite one extracted value in a vault with a value of your own. The cell keeps showing your value, and hides the citations and reasoning behind the extracted one, until you put it back with POST /vaults/{id}/documents/{documentId}/cells/{fieldKey}/revert.

value is always a string, whatever the column holds. Text, enum, email, URL, number, and percentage columns take the value as written. A checkbox column takes true or false. A date column takes YYYY-MM-DD. Multi-select and list columns take a JSON array of strings, for example ["Delaware","New York"]. Currency, duration, date-range, party, and related-agreement columns take the same JSON the read path returns for that column, so the safest way to build one is to read the cell first and edit what comes back.

An enum or multi-select value outside the column's configured options returns 400, and so does any column GC AI writes itself: the folder columns synced from a connected drive, and a Document Name column the vault manages through its naming template.

Editing a cell while its document is still being scanned is allowed. Your value wins: an extraction that lands afterwards does not overwrite it, so there is no need to poll for the scan to finish first.

A document that belongs to another vault returns 404, even when the caller can reach both vaults, and so does a column key this vault does not have. Read the keys from GET /vaults/{id}/columns.

Requires the editor or owner role in the vault and the organization-level permission to manage vaults. An archived vault returns 409: restore it first. A document that was deleted, or auto-removed as a duplicate copy, also returns 409, and so does a document stored before GC AI split bundled uploads, which has no cells of its own to write.

Requires a user-scoped API key (u:gcai_...). A vault is shared with named people, so an organization-scoped key has no identity to resolve vault access with.

patch/vaults/{id}/documents/{documentId}/cells/{fieldKey}

Request

Path parameters

idstring uuid required

The vault ID

documentIdstring uuid required

The document_id of a row from GET /vaults/{id}/documents.

fieldKeystring required

Column key, as the vault reports it for its columns. A key, not a label: governingLaw, not Governing law. Percent-encode it if it holds a character a URL path reserves.

Example:governingLaw

Request body

valuestring required

The value to store. Send an empty string to clear the cell.

Example request

{
  "value": "Delaware"
}

Response

The stored cell

document_idstring uuid required

Document the cell belongs to

field_keystring required

Column key for the cell

extracted_atstring nullable required

ISO 8601 timestamp of the last write that set a value on this cell. A revert restores the scanned value without restamping it, so after a revert this is still the time of the edit that was undone, not the time of the original scan.

Example response

{
  "cell": {
    "value": "Delaware"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.