Account

Create metadata

<small>Requires an API token with the Metadata Manager role.</small>

POST

/metadata

Create metadata

curl --request POST \
  --url https://app.fynk.com/v1/api/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "The discount rate applied to the company valuation in a follow-on financing round.",
  "display_name": "Discount Rate",
  "is_contract_value": true,
  "keywords": "discount, rate, valuation",
  "name": "discount_rate",
  "prompt": "Extract the discount rate percentage from the document.",
  "relevant_document_type_uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "select_values": [
    "<string>"
  ],
  "value_type": "text"
}
'

{
  "data": {
    "always_exists": true,
    "description": "The discount rate applied to the company valuation in a follow-on financing round.",
    "display_name": "Discount Rate",
    "is_contract_value": true,
    "keywords": "discount, rate, valuation",
    "name": "discount_rate",
    "prompt": "Extract the discount rate percentage from the document.",
    "relevant_document_type_uuids": [
      "<string>"
    ],
    "select_values": [
      "<string>"
    ],
    "settings": {
      "currencies": [
        "EUR",
        "USD"
      ]
    },
    "type": "system_autofilled",
    "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
    "value_type": "id"
  }
}

Creates a new account-level metadata field definition.

Note that the name and value_type sent in this request are fixed at the time of creation and cannot be changed later.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

descriptionstring | null

A description of the metadata field.

Maximum string length: 1024

Example: The discount rate applied to the company valuation in a follow-on financing round.

display_namestringrequired

The display name shown in the UI.

Maximum string length: 255

Example: Discount Rate

is_contract_valueboolean | null

Whether this is a contract value field. Can only be true when value_type is currency or currency_duration.

keywordsstring | null

Keywords to help with metadata identification.

Maximum string length: 1024

Example: discount, rate, valuation

namestringrequired

The programmatic name. Cannot be changed after creation. Must be lowercase alphanumeric with underscores only. Must be unique within the account and must not conflict with system metadata names.

Maximum string length: 255

Pattern: ^[a-z0-9_]+$

Example: discount_rate

promptstring | null

An AI prompt used for metadata extraction.

Maximum string length: 1024

Example: Extract the discount rate percentage from the document.

relevant_document_type_uuidsstring[] | null

UUIDs of document types this metadata is relevant for. null means not relevant to any document types. [] (empty array) means relevant to all document types.

select_valuesstring[] | null

The possible values when value_type is select or multi_select.

value_typeenum<string>required

Controls what kinds of values may be stored in the field. Cannot be changed after creation

Available options: id, uuid, bool, date, duration, email, list, number, currency, currency_duration, clause, select, multi_select, text, textarea, timestamp, array, enum

Example: text

Response

MetadataResource

dataobjectrequired

Show child attributes

Still need help? Share an idea