PAparsewise
Projects

Partially update a project

Update one or more fields on an existing project (supply only the fields you want to change). Returns the updated project. Returns 404 if the project does not exist.

patch/projects/{id}/

Request

  • Base URL
    https://api.parsewise.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

idstring uuid required

Request body

namestring

Human-readable name shown in the UI and in lists.

descriptionstring

Short description of what the project covers.

reference_datestring date nullable

Reference date used by agents that need a "today" anchor (e.g. relative date extractions). Defaults to the date the project was created.

auto_archive_after_daysinteger nullable

Opt-in auto-archival for document-oriented projects: documents uploaded more than this many days ago are automatically moved into an archived project by a daily sweep. Null disables auto-archival.

is_pinnedboolean

Whether the project is pinned to the top of the project list.

folder_idstring uuid nullable

Folder that contains this project. Null means the project sits at the root of the organisation folder tree.

Response

idstring uuid required

Stable identifier for the project (UUID).

namestring required

Human-readable name shown in the UI and in lists.

descriptionstring

Short description of what the project covers.

last_visited_atstring date-time nullable required

Timestamp of the most recent visit to this project.

reference_datestring date nullable

Reference date used by agents that need a "today" anchor (e.g. relative date extractions). Defaults to the date the project was created.

auto_archive_after_daysinteger nullable

Opt-in auto-archival for document-oriented projects: documents uploaded more than this many days ago are automatically moved into an archived project by a daily sweep. Null disables auto-archival.

document_countinteger required

Number of documents currently in the project.

agent_countinteger required

Number of non-draft agents configured on the project.

is_pinnedboolean

Whether the project is pinned to the top of the project list.

folder_idstring uuid nullable

Folder that contains this project. Null means the project sits at the root of the organisation folder tree.

project_modulesunknown required
target_output_schemaunknown required
output_mapping_statusstring required

Changes

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