Create Organization Api Key

Create a new api key for the organization. Successful response will contain the newly created api key.

POST /api/organization/api_key

Create Organization Api Key

cURL

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 '
{
  "name": "<string>",
  "role": 123,
  "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_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,
    "slim_chunks": true,
    "typo_options": {
      "correct_typos": true,
      "disable_on_word": [
        "<string>"
      ],
      "one_typo_word_range": {
        "min": 1,
        "max": 1
      },
      "prioritize_domain_specifc_words": true,
      "two_typo_word_range": {
        "min": 1,
        "max": 1
      }
    },
    "use_quote_negated_terms": true
  },
  "expires_at": "<string>",
  "scopes": [
    "<string>"
  ]
}
'

200

{
  "api_key": "<string>"
}

Authorizations

Authorization · string · header · required

Headers

TR-Organization · string<uuid> · required

The organization id to use for the request.

Body

application/json

JSON request payload to create a new organization api key

name · string · required

The name which will be assigned to the new api key.

role · integer<int32> · required

The role which will be assigned to the new api key. Either 0 (read), 1 (Admin) or 2 (Owner). The auth'ed user must have a role greater than or equal to the role being assigned.

dataset_ids · string<uuid>[] | null

The dataset ids which the api key will have access to. If not provided or empty, the api key will have access to all datasets in the dataset.

default_params · object | null

The default parameters which will be forcibly used when the api key is given on a request. If not provided, the api key will not have default parameters.

Show child attributes

expires_at · string | null

The expiration date of the api key. If not provided, the api key will not expire. This should be provided in UTC time.

scopes · string[] | null

The routes which the api key will have access to. If not provided or empty, the api key will have access to all routes. Specify the routes as a list of strings. For example, ["GET /api/dataset", "POST /api/dataset"].

Response

200

application/json

JSON body representing the api_key for the organization

api_key · string · required

The api key which was created. This is the value which should be used in the Authorization header.