---
title: "Create an extractor for a tool"
method: POST
path: "/tools/extractors"
tags: ["Tools"]
---

# Create an extractor for a tool

`POST /tools/extractors`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/tools/extractors`
- Auth: none declared

Creates a new extractor entry for a tool in the tool registry.

## Request body

- object
  - `toolExtractor` ToolsExtractorsPostRequestBodyContentApplicationJsonSchemaToolExtractor
    - `referenceId` string, required: The referenceId of the tool to extract from.
    - `name` string, required: The name of the extractor.
    - `description` string, required: A description of the extractor.
    - `language` 'json-query', required: The extractor query language.
    - `queries` ToolsExtractorsPostRequestBodyContentApplicationJsonSchemaToolExtractorQueriesItems[], required: The list of extractor queries.
      - `path` string, required: The query path to extract.
      - `label` string: An optional label for the extracted value.

## Response `200`

the created extractor document

- unknown

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)