Get Groups for Dataset

curl --request GET \
  --url https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'

import requests

url = "https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}"

headers = {
    "TR-Dataset": "<tr-dataset>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'TR-Dataset': '<tr-dataset>', Authorization: '<api-key>'}
};

fetch('https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}', 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/dataset/groups/{dataset_id}/{page}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "TR-Dataset: <tr-dataset>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("TR-Dataset", "<tr-dataset>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}")
  .header("TR-Dataset", "<tr-dataset>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "groups": [
    {
      "created_at": "2021-01-01 00:00:00.000",
      "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "description": "A group of chunks",
      "file_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "name": "Trieve",
      "tracking_id": "3",
      "updated_at": "2021-01-01 00:00:00.000"
    }
  ],
  "total_pages": 1,
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "Bad Request"
}

GET

api

dataset

groups

{dataset_id}

{page}

Get Groups for Dataset

curl --request GET \
  --url https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'

import requests

url = "https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}"

headers = {
    "TR-Dataset": "<tr-dataset>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'TR-Dataset': '<tr-dataset>', Authorization: '<api-key>'}
};

fetch('https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}', 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/dataset/groups/{dataset_id}/{page}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "TR-Dataset: <tr-dataset>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("TR-Dataset", "<tr-dataset>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}")
  .header("TR-Dataset", "<tr-dataset>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "groups": [
    {
      "created_at": "2021-01-01 00:00:00.000",
      "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "description": "A group of chunks",
      "file_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "name": "Trieve",
      "tracking_id": "3",
      "updated_at": "2021-01-01 00:00:00.000"
    }
  ],
  "total_pages": 1,
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "Bad Request"
}

Authorizations

Authorization

string

header

required

Headers

TR-Dataset

string<uuid>

required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Path Parameters

dataset_id

string<uuid>

required

The id of the dataset to fetch groups for.

page

integer<int64> | null

required

The page of groups to fetch. Page is 1-indexed. Only used if use_cursor = false.

Query Parameters

use_cursor

boolean | null

Flag to enable cursor mode, this runs faster for large scroll operations. Defaults to false

cursor

string<uuid> | null

The cursor offset for. Requires use_cursor = True. Defaults to 00000000-00000000-00000000-00000000. Group ids are compared to the cursor using a greater than or equal to.

Response

JSON body representing the groups created by the given dataset

groups

object[]

required

The list of all the groups.

Show child attributes

total_pages

integer<int32>

required

Total number of pages. Pages is groups_count / 10

Required range: x >= 0

next_cursor

string<uuid> | null

Parameter for the next cursor offset.

Chunk

Chunk Group

Topic

Message

Crawl

File

Analytics

Experiments

Dataset

Organization

User

Auth

Health

Invitation

Stripe

Metrics

Public

Get Groups for Dataset

Authorizations

Headers

Path Parameters

Query Parameters

Response