POST
/
api
/
organization
/
api_key
curl --request POST \
  --url https://api.trieve.ai/api/organization/api_key \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Organization: <tr-organization>' \
  --data '{
  "dataset_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "default_params": {
    "filters": {
      "must": [
        {
          "field": "tag_set",
          "match_all": [
            "A",
            "B"
          ]
        },
        {
          "field": "num_value",
          "range": {
            "gte": 10,
            "lte": 25
          }
        }
      ]
    },
    "highlight_options": {
      "highlight_delimiters": [
        "<string>"
      ],
      "highlight_max_length": 1,
      "highlight_max_num": 1,
      "highlight_results": true,
      "highlight_strategy": "exactmatch",
      "highlight_threshold": 123,
      "highlight_window": 1,
      "post_tag": "<string>",
      "pre_tag": "<string>"
    },
    "no_result_message": "<string>",
    "page_size": 1,
    "remove_stop_words": true,
    "score_threshold": 123,
    "search_type": "fulltext",
    "slim_chunks": true,
    "typo_options": {
      "correct_typos": true,
      "disable_on_word": [
        "<string>"
      ],
      "one_typo_word_range": {
        "max": 1,
        "min": 1
      },
      "prioritize_domain_specifc_words": true,
      "two_typo_word_range": {
        "max": 1,
        "min": 1
      }
    },
    "use_quote_negated_terms": true
  },
  "expires_at": "<string>",
  "name": "<string>",
  "role": 123,
  "scopes": [
    "<string>"
  ]
}'
{
  "api_key": "<string>"
}

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Organization
string
required

The organization id to use for the request.

Body

application/json
JSON request payload to create a new organization api key

The body is of type object.

Response

200
application/json
JSON body representing the api_key for the organization

The response is of type object.