--- title: "Create schema" method: POST path: "/api/v1/schemas" tags: ["Schema"] --- # Create schema `POST /api/v1/schemas` Create a new schema object. ## Request body - SchemaBase - `id` integer — ID of the schema. - `name` string — Name of the schema (not visible in UI). - `url` string, uri — URL of the schema. - `queues` string[] — List of queues that use schema object. - `metadata` Metadata — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details. - `modified_by` string, uri, nullable — User that last modified the object. - `modified_at` string, date-time, nullable — Timestamp of last modification. - `content` Section[] — Schema content: list of sections. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'section' - `icon` string, nullable — The icon that appears on the left panel in the UI for a given section (not yet supported on UI). - `children` union[] — Specifies objects grouped under a given section. It may contain multivalue or datapoint objects. - union - Multivalue - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'multivalue' - `min_occurrences` integer, nullable — Minimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default. - `max_occurrences` integer, nullable — Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default. - `show_grid_by_default` boolean — If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training. - `rir_field_names` string[], nullable — List of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple. - `grid` Grid — Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties. - `row_types` string[] — List of allowed row type values. - `default_row_type` string — Row type to be used by default. - `row_types_to_extract` string[] — Types of rows to be extracted to related table. - `children` union — Object specifying type of children. It may contain only objects with categories tuple or datapoint. - ContentTuple - … - union - … - union - object - `type` 'string' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `constraints` object - … - object - `type` 'number' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `format` string — Number format. - `aggregations` object — Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples). - … - `constraints` object - … - object - `type` 'date' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `format` string — Enforces a format for date datapoint on the UI. - `constraints` object - … - object - `type` 'enum' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `enum_value_type` 'string' | 'number' | 'date' — Data type of the option's value attribute. Must be one of string, number, date. - `constraints` object - … - `options` DatapointEnumOptionsItem[] — Options for enum datapoint. - … - object - `type` 'button' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `popup_url` string, uri — URL of a popup window to be opened when button is pressed. - `can_obtain_token` boolean — If set to true the popup window is allowed to ask the main Rossum window for authorization token. - `constraints` object - … ## Response `201` Created - Schema - `id` integer, required — ID of the schema. - `name` string, required — Name of the schema (not visible in UI). - `url` string, uri, required — URL of the schema. - `queues` string[], required — List of queues that use schema object. - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details. - `modified_by` string, uri, nullable, required — User that last modified the object. - `modified_at` string, date-time, nullable, required — Timestamp of last modification. - `content` Section[], required — Schema content: list of sections. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'section' - `icon` string, nullable — The icon that appears on the left panel in the UI for a given section (not yet supported on UI). - `children` union[] — Specifies objects grouped under a given section. It may contain multivalue or datapoint objects. - union - Multivalue - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'multivalue' - `min_occurrences` integer, nullable — Minimum number of occurrences of nested objects. If condition of min_occurrences is violated corresponding fields should be manually reviewed. Minimum required value for the field is 0. If not specified, it is set to 0 by default. - `max_occurrences` integer, nullable — Maximum number of occurrences of nested objects. All additional rows above max_occurrences are removed by extraction process. Minimum required value for the field is 1. If not specified, it is set to 1000 by default. - `show_grid_by_default` boolean — If set to true, the magic-grid is opened instead of footer upon entering the multivalue. Default false. Applied only in UI. Useful when annotating documents for custom training. - `rir_field_names` string[], nullable — List of names used to initialize content from the AI engine predictions. If specified, the value of the first field from the array is used, otherwise default name line_items is used. Attribute can be set only for multivalue containing objects with category tuple. - `grid` Grid — Multivalue grid object allows to specify a row type for each row of the grid. Configure magic-grid feature properties. - `row_types` string[] — List of allowed row type values. - `default_row_type` string — Row type to be used by default. - `row_types_to_extract` string[] — Types of rows to be extracted to related table. - `children` union — Object specifying type of children. It may contain only objects with categories tuple or datapoint. - ContentTuple - … - union - … - union - object - `type` 'string' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `constraints` object - … - object - `type` 'number' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `format` string — Number format. - `aggregations` object — Aggregations allow computation of some informative values, e.g. a sum of a table column with numeric values. These are returned among messages when /v1/annotations/{id}/content/validate endpoint is called. Aggregations can be computed only for tables (multivalues of tuples). - … - `constraints` object - … - object - `type` 'date' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `format` string — Enforces a format for date datapoint on the UI. - `constraints` object - … - object - `type` 'enum' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `enum_value_type` 'string' | 'number' | 'date' — Data type of the option's value attribute. Must be one of string, number, date. - `constraints` object - … - `options` DatapointEnumOptionsItem[] — Options for enum datapoint. - … - object - `type` 'button' — Data type of the object. - `id` string — Unique identifier of an object. Maximum length is 50 characters. - `label` string — User-friendly label for an object, shown in the user interface. - `hidden` boolean — If set to true, the object is not visible in the user interface, but remains stored in the database and may be exported. Default is false. Note that section is hidden if all its children are hidden. - `disable_prediction` boolean — Can be set to true to disable field extraction, while still preserving the data shape. Ignored by aurora engines. - `category` 'datapoint' - `can_export` boolean — If set to false, datapoint is not exported through export endpoint. Default is true. - `can_collapse` boolean — If set to true, tabular (multivalue-tuple) datapoint may be collapsed in the UI. Default is false. - `rir_field_names` string[] — List of references used to initialize an object value. - `default_value` union — Default value used either for fields that do not use hints from AI engine predictions (i.e. rir_field_names are not specified), or when the AI engine does not return any data for the field. - … - `ui_configuration` object — UI configuration provides a group of settings, which alter behaviour of the field in the application. This does not affect behaviour of the field via the API. - … - `width` integer — Width of the column (in characters). Default widths are number 8, string 20, date 10, enum 20. Only supported for table datapoints. - `stretch` boolean — If total width of columns doesn't fill up the screen, datapoints with stretch set to true will be expanded proportionally to other stretching columns. Only supported for table datapoints. - `width_chars` integer — (Deprecated) Use width and stretch properties instead. - `score_threshold` number — Threshold used to automatically validate field content based on AI confidence scores. If not set, queue.default_score_threshold is used. - `formula` string — Formula definition, required only for fields of type formula. rir_field_names should also be empty for these fields. - `prompt` string — Prompt definition, required only for fields of type reasoning. - `context` string[] — Context for the prompt, required only for fields of type reasoning. - `matching` object — Matching configuration, required for fields of type lookup. Defines how the lookup is performed — either via a hook interface or a built-in type. - … - `popup_url` string, uri — URL of a popup window to be opened when button is pressed. - `can_obtain_token` boolean — If set to true the popup window is allowed to ask the main Rossum window for authorization token. - `constraints` object - … ## Other responses - `400` — Invalid input data. - `401` — The username/password is invalid or token is invalid (e.g. expired). - `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue. - `404` — The specified resource was not found. - `409` — Conflict - `413` — Payload too large (especially for files uploaded). - `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details. - `500` — Server failure while processing the request. - `502` — Invalid response from the upstream server. - `503` — We're temporarily offline for maintenance. Please try again later. - `504` — Upstream server could not complete the request in time. --- [API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)