Get Datasets - Maxim Docs

Overview

Prompts

Prompt Tools

Prompt Partials

Datasets

Evaluators

Log repositories

Folders

Workflows

Integrations

Alerts

Models

Test runs

Test run entries

Test run reports

Logging

Workspaces

Get Datasets

curl --request GET \
  --url https://api.getmaxim.ai/v1/datasets \
  --header 'x-maxim-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-maxim-api-key': '<api-key>'}};

fetch('https://api.getmaxim.ai/v1/datasets', 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.getmaxim.ai/v1/datasets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-maxim-api-key: <api-key>"
  ],
]);

$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.getmaxim.ai/v1/datasets"

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

	req.Header.Add("x-maxim-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/datasets")

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

request = Net::HTTP::Get.new(url)
request["x-maxim-api-key"] = '<api-key>'

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

[
  {
    "id": "<string>",
    "name": "<string>",
    "config": {},
    "description": "<string>",
    "accountId": "<string>",
    "workspaceId": "<string>",
    "folderId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "columns": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "meta": {
          "columnDataType": "<string>",
          "delimiter": "<string>"
        },
        "columnType": "<string>"
      }
    ],
    "entriesCount": 123
  }
]

GET

datasets

Get Datasets

curl --request GET \
  --url https://api.getmaxim.ai/v1/datasets \
  --header 'x-maxim-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-maxim-api-key': '<api-key>'}};

fetch('https://api.getmaxim.ai/v1/datasets', 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.getmaxim.ai/v1/datasets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-maxim-api-key: <api-key>"
  ],
]);

$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.getmaxim.ai/v1/datasets"

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

	req.Header.Add("x-maxim-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/datasets")

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

request = Net::HTTP::Get.new(url)
request["x-maxim-api-key"] = '<api-key>'

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

[
  {
    "id": "<string>",
    "name": "<string>",
    "config": {},
    "description": "<string>",
    "accountId": "<string>",
    "workspaceId": "<string>",
    "folderId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "columns": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "meta": {
          "columnDataType": "<string>",
          "delimiter": "<string>"
        },
        "columnType": "<string>"
      }
    ],
    "entriesCount": 123
  }
]

Authorizations

x-maxim-api-key

string

header

required

API key for authentication

Query Parameters

string

Unique identifier for the dataset

listSplits

boolean | null

Whether to list splits within a dataset

workspaceId

string

required

Unique identifier for the workspace

folderId

string

Unique identifier for the folder

limit

number | null

default:20

Maximum number of records to return (max: 100)

Required range: x <= 100

cursor

string | null

Cursor for pagination

Response

Datasets retrieved successfully

string

required

name

string

required

config

object | null

required

description

string

required

accountId

string

required

workspaceId

string

required

folderId

string | null

required

createdAt

string

required

updatedAt

string

required

deletedAt

string | null

required

columns

object[]

required

Show child attributes

entriesCount

number

required

⌘I