Skip to main content
GET
List datasets

Authorizations

Authorization
string
header
required

Static, non-expiring API key: Authorization: Bearer <FOURMINDS_API_KEY>.

Query Parameters

status
string

Return only datasets with this status, e.g. in_use, unused, preparing, failed.

search_text
string

Case-insensitive match anywhere in the dataset name. _ matches any single character and % matches any text.

is_shared
boolean

Filter by sharing. false returns only your own datasets that aren't shared. Omit to return all datasets.

sort_by
enum<string>

Sort field. When omitted, results are ordered by updated_at, newest first.

Available options:
name,
status,
created_at,
updated_at,
size,
files_count
sort_order
enum<string>
default:desc

Sort direction. Only applies when sort_by is set.

Available options:
asc,
desc
limit
integer

Maximum number of datasets to return. When set, the response is a paginated object instead of an array.

Required range: 1 <= x <= 500
offset
integer
default:0

Number of datasets to skip. Only applies when limit is set.

Required range: x >= 0

Response

Success. An array of datasets, or a paginated object when limit is set.

id
integer
required
name
string
required
description
string | null
required
tags
string[] | null
required
status
string
required
Examples:

"in_use"

"unused"

"preparing"

"failed"

error_message
string | null
required
file_count
integer
required
file_types
string[]
required

File extensions present in the dataset.

Example:
file_rows_total
integer
required
file_bytes_total
integer
required
urls
object[] | null
required
size
integer
required

Total size in bytes.

is_saved
boolean
required
graph_status
string | null
required
Examples:

"preparing"

"ready"

graph_build_progress
integer | null
required
files_processed_count
integer | null
required
total_chunks_count
integer | null
required
graph_build_metadata
object | null
required
fine_tuning_status
boolean | null
required
integration_types
string[] | null
required
Example:
is_private
boolean | null
required
shared_with_organization
boolean | null
required
team_ids
string[] | null
required
team_names
string[] | null
required
shared_user_count
integer
required
owner_email
string | null
required

Filled in by List datasets; null from Get a dataset and Create a dataset.

is_shared
boolean
required
organization_name
string | null
required

Filled in by List datasets; null from Get a dataset and Create a dataset.

created_at
string<date-time>
required
updated_at
string<date-time>
required
latest_job
object | null
required
is_syncing
boolean
required
active_sync_job_id
string | null
required
sync_started_at
string<date-time> | null
required