PAparsewise
Dimensions

Partially update a dimension

Update one or more fields on an existing dimension (supply only the fields you want to change). Renaming is subject to the same name-collision rules as create. Returns the updated dimension.

patch/projects/{project_id}/dimensions/{dimension_id}/

Request

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

Path parameters

dimension_idstring uuid required
project_idstring uuid required

Request body

namestring

Human-readable name of the dimension. Must be unique within the project. Cannot match the reserved system dimension name "Document" or any of the project's tag keys.

descriptionstring

Optional free-form description of what this dimension captures.

example_valuesstring

Optional comma-separated list of example values to help guide extraction.

value_type'string' | 'number'
  • string - String
  • number - Number

Response

idstring uuid required

Stable identifier for the dimension (UUID).

project_idstring uuid required

Identifier of the project this dimension belongs to.

namestring required

Human-readable name of the dimension. Must be unique within the project. Cannot match the reserved system dimension name "Document" or any of the project's tag keys.

descriptionstring

Optional free-form description of what this dimension captures.

example_valuesstring

Optional comma-separated list of example values to help guide extraction.

value_type'string' | 'number'
  • string - String
  • number - Number
source'CUSTOM' | 'DOCUMENT' | 'TAG' required
  • CUSTOM - CUSTOM
  • DOCUMENT - DOCUMENT
  • TAG - TAG
source_agent_idstring uuid nullable required

ID of the list agent that supplies this dimension's allowed values, or null when the values are set manually. Agents using the dimension wait for this agent to finish and only record values from its resolved list.

auto_attach_to_new_agentsboolean required

Whether this dimension is automatically attached to newly created agents.

created_atstring date-time required

Timestamp the dimension was created.

Changes

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