Create a taxonomy

post

https://api.hrflow.ai/v1/taxonomy

Create a new taxonomy. The "other" default tag is always created.

With a public base_taxonomy_key, the base's tags are copied into the new taxonomy; with a protected one, the taxonomy aliases the base's tags read-only.

If tags is provided, it is applied after creation as a full replacement of the tag set (see PATCH /taxonomy), so it also replaces tags copied from a public base.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

value

string

required

Technical, code-like identifier of the taxonomy.

label

string

required

Human-readable label of the taxonomy.

language

string

Language of the taxonomy (e.g. en, fr).

reference

string

Optional. Unique per team - returns 409 on collision.

description

string

subtypes

array of strings

Item kinds this taxonomy applies to.

subtypes

Allowed:

scope

string

enum

Visibility of the taxonomy. Defaults to private.

Allowed:

parent_key

string

Parent taxonomy key (must belong to the same team).

base_taxonomy_key

string

Key of a public or protected HrFlow.ai / France Travail taxonomy to derive from.

classifier_key

string

Classifier key - must have model_type = "tagging".

201Taxonomy created.

400Validation error: missing value/label, invalid scope or subtypes, base taxonomy not a public/protected HrFlow.ai / France Travail taxonomy, classifier not of type tagging, or duplicate tag values in tags.

404Referenced parent_key, base_taxonomy_key or classifier_key not found.

409Duplicate reference or tag value.

429Rate limit exceeded.