Create account document type
create-account-document-typeCreate a new custom document type for the account.
Use this tool when:
The user asks for a new kind of document to be distinguished, e.g. "add a Framework Agreement document type"
A document or template needs a document type that the account does not have yet
Call list-account-document-types first: fynk already provides system document types such as "Non-Disclosure Agreement", "Rental Agreement" or "Service Agreement" to every account, and a custom type that duplicates one of them splits the account's documents across two types. Create a new type only when none of the existing ones fits.
Write name in Title Case, the way fynk's own types are named ("Data Processing Agreement", "Letter of Intent"),
rather than copying the user's phrasing verbatim - a request for "a type for supplier framework contracts" should
produce "Supplier Framework Agreement".
description and prompt are how a new type is normally set up, so propose both from what the type is for rather
than leaving them out:
descriptiontells users what the type covers, in one sentence. fynk's "Rental Agreement" reads: "A contract between a landlord and tenant defining the terms under which property is rented, including duration, payment terms, and usage conditions."promptis what fynk's AI analyses read when deciding whether a document is of this type - without one, they rarely pick the type. Phrase it as a selection criterion, the way fynk's own types do. "Rental Agreement" reads: "Select this type if the document defines the terms under which a tenant rents property from a landlord, including rent amount, duration, deposit, and usage conditions."
relevant_metadata_uuids decides which metadata fields fynk's AI analyses look for in documents of this type,
besides the fields already relevant for every document type, which apply to the new type automatically. Call
list-account-metadata to find the candidates, and propose the fields that type's documents would carry, e.g. a
"Net Rent" field for a lease type. The fields chosen here are made relevant for the new type alongside the types they already have, and
list-account-metadata reports the result: each field there names the document types it is relevant for.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the document type, unique among the account's custom document types, in Title Case (max 255 characters), e.g. "Supplier Framework Agreement" | |
| prompt | No | Selection criterion the AI analyses use to decide whether a document is of this type (max 1024 characters), phrased like "Select this type if the document ..." | |
| description | No | One sentence describing what the document type covers, shown to users (max 1024 characters) | |
| relevant_metadata_uuids | No | Uuids from list-account-metadata of the fields to make relevant for this document type, on top of the fields already relevant for every document type. Only the account's own fields and system_reference fields are accepted |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Name of the document type | |
| uuid | No | Identifier for the document type. Do not show to the user unless they ask for it | |
| prompt | No | The selection criterion fynk's AI analyses use to decide whether a document is of this type. Absent when it has none, in which case the analyses rarely pick the type. | |
| customised | No | Present, and true, only for a system document type that this account has customised. The customisation can be dropped again with update-account-document-type and `reset_to_fynk_default` | |
| description | No | What the document type covers, as shown to users configuring it. Absent when it has none. | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| provided_by_fynk | No | Present, and true, only for one of fynk's built-in system document types. The account can customise or deactivate such a type but never delete it. Absent for a type the account created itself |