Create 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 '
{
"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>"
]
}
'import requests
url = "https://api.trieve.ai/api/organization/api_key"
payload = {
"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>"]
}
headers = {
"TR-Organization": "<tr-organization>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'TR-Organization': '<tr-organization>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>']
})
};
fetch('https://api.trieve.ai/api/organization/api_key', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trieve.ai/api/organization/api_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"TR-Organization: <tr-organization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trieve.ai/api/organization/api_key"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"role\": 123,\n \"dataset_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"default_params\": {\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"highlight_options\": {\n \"highlight_delimiters\": [\n \"<string>\"\n ],\n \"highlight_max_length\": 1,\n \"highlight_max_num\": 1,\n \"highlight_results\": true,\n \"highlight_threshold\": 123,\n \"highlight_window\": 1,\n \"post_tag\": \"<string>\",\n \"pre_tag\": \"<string>\"\n },\n \"no_result_message\": \"<string>\",\n \"page_size\": 1,\n \"remove_stop_words\": true,\n \"score_threshold\": 123,\n \"slim_chunks\": true,\n \"typo_options\": {\n \"correct_typos\": true,\n \"disable_on_word\": [\n \"<string>\"\n ],\n \"one_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n },\n \"prioritize_domain_specifc_words\": true,\n \"two_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n }\n },\n \"use_quote_negated_terms\": true\n },\n \"expires_at\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TR-Organization", "<tr-organization>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trieve.ai/api/organization/api_key")
.header("TR-Organization", "<tr-organization>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"role\": 123,\n \"dataset_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"default_params\": {\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"highlight_options\": {\n \"highlight_delimiters\": [\n \"<string>\"\n ],\n \"highlight_max_length\": 1,\n \"highlight_max_num\": 1,\n \"highlight_results\": true,\n \"highlight_threshold\": 123,\n \"highlight_window\": 1,\n \"post_tag\": \"<string>\",\n \"pre_tag\": \"<string>\"\n },\n \"no_result_message\": \"<string>\",\n \"page_size\": 1,\n \"remove_stop_words\": true,\n \"score_threshold\": 123,\n \"slim_chunks\": true,\n \"typo_options\": {\n \"correct_typos\": true,\n \"disable_on_word\": [\n \"<string>\"\n ],\n \"one_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n },\n \"prioritize_domain_specifc_words\": true,\n \"two_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n }\n },\n \"use_quote_negated_terms\": true\n },\n \"expires_at\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trieve.ai/api/organization/api_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TR-Organization"] = '<tr-organization>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"role\": 123,\n \"dataset_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"default_params\": {\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"highlight_options\": {\n \"highlight_delimiters\": [\n \"<string>\"\n ],\n \"highlight_max_length\": 1,\n \"highlight_max_num\": 1,\n \"highlight_results\": true,\n \"highlight_threshold\": 123,\n \"highlight_window\": 1,\n \"post_tag\": \"<string>\",\n \"pre_tag\": \"<string>\"\n },\n \"no_result_message\": \"<string>\",\n \"page_size\": 1,\n \"remove_stop_words\": true,\n \"score_threshold\": 123,\n \"slim_chunks\": true,\n \"typo_options\": {\n \"correct_typos\": true,\n \"disable_on_word\": [\n \"<string>\"\n ],\n \"one_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n },\n \"prioritize_domain_specifc_words\": true,\n \"two_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n }\n },\n \"use_quote_negated_terms\": true\n },\n \"expires_at\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"api_key": "<string>"
}{
"message": "Bad Request"
}Organization
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 --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>"
]
}
'import requests
url = "https://api.trieve.ai/api/organization/api_key"
payload = {
"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>"]
}
headers = {
"TR-Organization": "<tr-organization>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'TR-Organization': '<tr-organization>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>']
})
};
fetch('https://api.trieve.ai/api/organization/api_key', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trieve.ai/api/organization/api_key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"TR-Organization: <tr-organization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trieve.ai/api/organization/api_key"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"role\": 123,\n \"dataset_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"default_params\": {\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"highlight_options\": {\n \"highlight_delimiters\": [\n \"<string>\"\n ],\n \"highlight_max_length\": 1,\n \"highlight_max_num\": 1,\n \"highlight_results\": true,\n \"highlight_threshold\": 123,\n \"highlight_window\": 1,\n \"post_tag\": \"<string>\",\n \"pre_tag\": \"<string>\"\n },\n \"no_result_message\": \"<string>\",\n \"page_size\": 1,\n \"remove_stop_words\": true,\n \"score_threshold\": 123,\n \"slim_chunks\": true,\n \"typo_options\": {\n \"correct_typos\": true,\n \"disable_on_word\": [\n \"<string>\"\n ],\n \"one_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n },\n \"prioritize_domain_specifc_words\": true,\n \"two_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n }\n },\n \"use_quote_negated_terms\": true\n },\n \"expires_at\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TR-Organization", "<tr-organization>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trieve.ai/api/organization/api_key")
.header("TR-Organization", "<tr-organization>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"role\": 123,\n \"dataset_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"default_params\": {\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"highlight_options\": {\n \"highlight_delimiters\": [\n \"<string>\"\n ],\n \"highlight_max_length\": 1,\n \"highlight_max_num\": 1,\n \"highlight_results\": true,\n \"highlight_threshold\": 123,\n \"highlight_window\": 1,\n \"post_tag\": \"<string>\",\n \"pre_tag\": \"<string>\"\n },\n \"no_result_message\": \"<string>\",\n \"page_size\": 1,\n \"remove_stop_words\": true,\n \"score_threshold\": 123,\n \"slim_chunks\": true,\n \"typo_options\": {\n \"correct_typos\": true,\n \"disable_on_word\": [\n \"<string>\"\n ],\n \"one_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n },\n \"prioritize_domain_specifc_words\": true,\n \"two_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n }\n },\n \"use_quote_negated_terms\": true\n },\n \"expires_at\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trieve.ai/api/organization/api_key")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TR-Organization"] = '<tr-organization>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"role\": 123,\n \"dataset_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"default_params\": {\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"highlight_options\": {\n \"highlight_delimiters\": [\n \"<string>\"\n ],\n \"highlight_max_length\": 1,\n \"highlight_max_num\": 1,\n \"highlight_results\": true,\n \"highlight_threshold\": 123,\n \"highlight_window\": 1,\n \"post_tag\": \"<string>\",\n \"pre_tag\": \"<string>\"\n },\n \"no_result_message\": \"<string>\",\n \"page_size\": 1,\n \"remove_stop_words\": true,\n \"score_threshold\": 123,\n \"slim_chunks\": true,\n \"typo_options\": {\n \"correct_typos\": true,\n \"disable_on_word\": [\n \"<string>\"\n ],\n \"one_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n },\n \"prioritize_domain_specifc_words\": true,\n \"two_typo_word_range\": {\n \"min\": 1,\n \"max\": 1\n }\n },\n \"use_quote_negated_terms\": true\n },\n \"expires_at\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"api_key": "<string>"
}{
"message": "Bad Request"
}Authorizations
Headers
The organization id to use for the request.
Body
application/json
JSON request payload to create a new organization api key
The name which will be assigned to the new api key.
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.
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.
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
Show child attributes
The expiration date of the api key. If not provided, the api key will not expire. This should be provided in UTC time.
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
JSON body representing the api_key for the organization
The api key which was created. This is the value which should be used in the Authorization header.
Was this page helpful?
⌘I