Create Organization Api Key

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

name

string

required

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

role

integer

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[] | 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

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.

default_params.filters

object

ChunkFilter is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata.

default_params.filters.must

object[] | null

All of these field conditions have to match for the chunk to be included in the result set.

Filters can be constructed using either fields on the chunk objects, ids or tracking ids of chunks, and finally ids or tracking ids of groups.

default_params.filters.must.field

string

required

Field is the name of the field to filter on. Commonly used fields are timestamp, link, tag_set, location, num_value, group_ids, and group_tracking_ids. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with metadata..

default_params.filters.must.boolean

boolean | null

Boolean is a true false value for a field. This only works for boolean fields. You can specify this if you want values to be true or false.

default_params.filters.must.date_range

object

DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone.

Example:

{
  "gt": "2021-01-01 00:00:00.000",
  "gte": "2021-01-01 00:00:00.000",
  "lt": "2021-01-01 00:00:00.000",
  "lte": "2021-01-01 00:00:00.000"
}

default_params.filters.must.geo_bounding_box

object

default_params.filters.must.geo_polygon

object

default_params.filters.must.geo_radius

object

default_params.filters.must.match_all

(string | integer | number)[] | null

Match all lets you pass in an array of values that will return results if all of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used.

default_params.filters.must.match_any

(string | integer | number)[] | null

Match any lets you pass in an array of values that will return results if any of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used.

default_params.filters.must.range

object

Example:

{ "gt": 0, "gte": 0, "lt": 1, "lte": 1 }

default_params.filters.must_not

object[] | null

None of these field conditions can match for the chunk to be included in the result set.

Filters can be constructed using either fields on the chunk objects, ids or tracking ids of chunks, and finally ids or tracking ids of groups.

default_params.filters.must_not.field

string

required

default_params.filters.must_not.boolean

boolean | null

Boolean is a true false value for a field. This only works for boolean fields. You can specify this if you want values to be true or false.

default_params.filters.must_not.date_range

object

Example:

{
  "gt": "2021-01-01 00:00:00.000",
  "gte": "2021-01-01 00:00:00.000",
  "lt": "2021-01-01 00:00:00.000",
  "lte": "2021-01-01 00:00:00.000"
}

default_params.filters.must_not.geo_bounding_box

object

default_params.filters.must_not.geo_polygon

object

default_params.filters.must_not.geo_radius

object

default_params.filters.must_not.match_all

(string | integer | number)[] | null

default_params.filters.must_not.match_any

(string | integer | number)[] | null

default_params.filters.must_not.range

object

Example:

{ "gt": 0, "gte": 0, "lt": 1, "lte": 1 }

default_params.filters.should

object[] | null

Only one of these field conditions has to match for the chunk to be included in the result set.

Filters can be constructed using either fields on the chunk objects, ids or tracking ids of chunks, and finally ids or tracking ids of groups.

default_params.filters.should.field

string

required

default_params.filters.should.boolean

boolean | null

Boolean is a true false value for a field. This only works for boolean fields. You can specify this if you want values to be true or false.

default_params.filters.should.date_range

object

Example:

{
  "gt": "2021-01-01 00:00:00.000",
  "gte": "2021-01-01 00:00:00.000",
  "lt": "2021-01-01 00:00:00.000",
  "lte": "2021-01-01 00:00:00.000"
}

default_params.filters.should.geo_bounding_box

object

default_params.filters.should.geo_polygon

object

default_params.filters.should.geo_radius

object

default_params.filters.should.match_all

(string | integer | number)[] | null

default_params.filters.should.match_any

(string | integer | number)[] | null

default_params.filters.should.range

object

Example:

{ "gt": 0, "gte": 0, "lt": 1, "lte": 1 }

Example:

{
  "must": [
    {
      "field": "tag_set",
      "match_all": ["A", "B"]
    },
    {
      "field": "num_value",
      "range": { "gte": 10, "lte": 25 }
    }
  ]
}

default_params.highlight_options

object

Highlight Options lets you specify different methods to highlight the chunks in the result set. If not specified, this defaults to the score of the chunks.

default_params.highlight_options.highlight_delimiters

string[] | null

Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to ["?", ",", ".", "!"]. These are the characters that will be used to split the chunk_html into splits for highlighting. These are the characters that will be used to split the chunk_html into splits for highlighting.

default_params.highlight_options.highlight_max_length

integer | null

Set highlight_max_length to control the maximum number of tokens (typically whitespace separated strings, but sometimes also word stems) which can be present within a single highlight. If not specified, this defaults to 8. This is useful to shorten large splits which may have low scores due to length compared to the query. Set to something very large like 100 to highlight entire splits.

Required range: x >= 0

default_params.highlight_options.highlight_max_num

integer | null

Set highlight_max_num to control the maximum number of highlights per chunk. If not specified, this defaults to 3. It may be less than 3 if no snippets score above the highlight_threshold.

Required range: x >= 0

default_params.highlight_options.highlight_results

boolean | null

Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add  tags to the chunk_html of the chunks to highlight matching splits and return the highlights on each scored chunk in the response.

default_params.highlight_options.highlight_strategy

enum<string>

Available options:

exactmatch,

v1

default_params.highlight_options.highlight_threshold

number | null

Set highlight_threshold to a lower or higher value to adjust the sensitivity of the highlights applied to the chunk html. If not specified, this defaults to 0.8. The range is 0.0 to 1.0.

default_params.highlight_options.highlight_window

integer | null

Set highlight_window to a number to control the amount of words that are returned around the matched phrases. If not specified, this defaults to 0. This is useful for when you want to show more context around the matched words. When specified, window/2 whitespace separated words are added before and after each highlight in the response's highlights array. If an extended highlight overlaps with another highlight, the overlapping words are only included once. This parameter can be overriden to respect the highlight_max_length param.

Required range: x >= 0

default_params.highlight_options.post_tag

string | null

Custom html tag which should appear after highlights. If not specified, this defaults to ''.

default_params.highlight_options.pre_tag

string | null

Custom html tag which should appear before highlights. If not specified, this defaults to ''.

default_params.no_result_message

string | null

Options for handling the response for the llm to return when no results are found

default_params.page_size

integer | null

Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.

Required range: x >= 0

default_params.remove_stop_words

boolean | null

If true, stop words will be removed. Queries that are entirely stop words will be preserved.

default_params.score_threshold

number | null

Set score_threshold to a float to filter out chunks with a score below the threshold.

default_params.search_type

enum<string>

Available options:

fulltext,

semantic,

hybrid,

bm25

default_params.slim_chunks

boolean | null

Set slim_chunks to true to avoid returning the content and chunk_html of the chunks.

default_params.typo_options

object

Typo Options lets you specify different methods to correct typos in the query. If not specified, typos will not be corrected.

default_params.use_quote_negated_terms

boolean | null

If true, quoted and - prefixed words will be parsed from the queries and used as required and negated words respectively.

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.

Was this page helpful?

Raise issue

Create Organization Update All Dataset Configurations

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>"
}

Chunk

Chunk Group

Topic

Message

Crawl

File

Analytics

Dataset

Organization

User

Auth

Health

Invitation

Stripe

Metrics

Create Organization Api Key

Authorizations

Headers

Body

Response