How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Argilla datasets API

The datasets API from Argilla — 19 operation(s) for datasets.

Argilla datasets API is one of 15 APIs that Argilla publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Datasets. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 26 operations across 19 paths, and defines 103 schemas. It is described by OpenAPI 3.2.0, at version 2.8.0.

Requests are made against a single base URL, https://argilla.io/api/v1.

26 operations 19 paths 103 schemas 2 DELETE11 GET1 PATCH10 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.8.0
Base URL
https://argilla.io
Authentication
API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

Argilla datasets API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Argilla-Api-Key (APIKeyHeader). It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 26

Across 19 paths, the API surfaces 26 operations — 2 DELETE, 11 GET, 1 PATCH, 10 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

datasets 26
GET
/me/datasets
List Current User Datasets
list_current_user_datasets_me_datasets_get 3 params → 200400404403409422500
GET
/datasets/{dataset_id}/fields
List Dataset Fields
list_dataset_fields_datasets__dataset_id__fields_get 1 param → 200400404403409422500
POST
/datasets/{dataset_id}/fields
Create Dataset Field
create_dataset_field_datasets__dataset_id__fields_post 1 param body → 201400404403409422500
GET
/datasets/{dataset_id}/vectors-settings
List Dataset Vector Settings
list_dataset_vector_settings_datasets__dataset_id__vectors_settings_get 1 param → 200400404403409422500
POST
/datasets/{dataset_id}/vectors-settings
Create Dataset Vector Settings
create_dataset_vector_settings_datasets__dataset_id__vectors_settings_post 1 param body → 201400404403409422500
GET
/me/datasets/{dataset_id}/metadata-properties
List Current User Dataset Metadata Properties
list_current_user_dataset_metadata_properties_me_datasets__dataset_id__metadata_properties_get 1 param → 200400404403409422500
GET
/datasets/{dataset_id}
Get Dataset
get_dataset_datasets__dataset_id__get 1 param → 200400404403409422500
DELETE
/datasets/{dataset_id}
Delete Dataset
delete_dataset_datasets__dataset_id__delete 1 param → 200400404403409422500
PATCH
/datasets/{dataset_id}
Update Dataset
update_dataset_datasets__dataset_id__patch 1 param body → 200400404403409422500
GET
/me/datasets/{dataset_id}/metrics
Get Current User Dataset Metrics
get_current_user_dataset_metrics_me_datasets__dataset_id__metrics_get 1 param → 200400404403409422500
GET
/datasets/{dataset_id}/progress
Get Dataset Progress
get_dataset_progress_datasets__dataset_id__progress_get 1 param → 200400404403409422500
GET
/datasets/{dataset_id}/users/progress
Get Dataset Users Progress
get_dataset_users_progress_datasets__dataset_id__users_progress_get 1 param → 200400404403409422500
POST
/datasets
Create Dataset
create_dataset_datasets_post body → 201400404403409422500
POST
/datasets/{dataset_id}/metadata-properties
Create Dataset Metadata Property
create_dataset_metadata_property_datasets__dataset_id__metadata_properties_post 1 param body → 201400404403409422500
PUT
/datasets/{dataset_id}/publish
Publish Dataset
publish_dataset_datasets__dataset_id__publish_put 1 param → 200400404403409422500
POST
/datasets/{dataset_id}/import
Import Dataset From Hub
import_dataset_from_hub_datasets__dataset_id__import_post 1 param body → 202400404403409422500
POST
/datasets/{dataset_id}/export
Export Dataset To Hub
export_dataset_to_hub_datasets__dataset_id__export_post 1 param body → 202400404403409422500
GET
/datasets/{dataset_id}/questions
List Dataset Questions
list_dataset_questions_datasets__dataset_id__questions_get 1 param → 200400404403409422500
POST
/datasets/{dataset_id}/questions
Create Dataset Question
create_dataset_question_datasets__dataset_id__questions_post 1 param body → 201400404403409422500
GET
/datasets/{dataset_id}/records
List Dataset Records
list_dataset_records_datasets__dataset_id__records_get 4 params → 200400404403409422500
DELETE
/datasets/{dataset_id}/records
Delete Dataset Records
delete_dataset_records_datasets__dataset_id__records_delete 2 params → 204400404403409422500
POST
/me/datasets/{dataset_id}/records/search
Search Current User Dataset Records
search_current_user_dataset_records_me_datasets__dataset_id__records_search_post 4 params body → 200400404403409422500
POST
/datasets/{dataset_id}/records/search
Search Dataset Records
search_dataset_records_datasets__dataset_id__records_search_post 4 params body → 200400404403409422500
GET
/datasets/{dataset_id}/records/search/suggestions/options
List Dataset Records Search Suggestions Options
list_dataset_records_search_suggestions_options_datasets__dataset_id__records_search_suggestions_options_get 1 param → 200400404403409422500
POST
/datasets/{dataset_id}/records/bulk
Create Dataset Records Bulk
create_dataset_records_bulk_datasets__dataset_id__records_bulk_post 1 param body → 201400404403409422500
PUT
/datasets/{dataset_id}/records/bulk
Upsert Dataset Records Bulk
upsert_dataset_records_bulk_datasets__dataset_id__records_bulk_put 1 param body → 200400404403409422500

Schemas 103

The contract defines 103 schemas that model the data the API accepts and returns. The most detailed are Record (11 properties), Dataset (11 properties), Question (9 properties), Suggestion (8 properties). Each schema is shown below with its type and property counts.

RecordFilterScope
object
2 properties 2 required
SimilarityOrder
string
TextQuestionSettingsCreate
object
2 properties 1 required
Filters
object
1 property
TextQuestionSettings
object
2 properties 1 required
RecordsBulkCreate
object
1 property 1 required
DatasetProgress
object
4 properties 3 required
HubDataset
object
4 properties 4 required
SearchSuggestionOptions
object
2 properties 2 required
TermsMetadataPropertyCreate
object
2 properties 1 required
IntegerMetadataPropertyCreate
object
3 properties 1 required
DatasetMetrics
object
1 property 1 required
MetadataProperties
object
1 property 1 required
RecordsBulk
object
1 property 1 required
DatasetUpdate
object
5 properties
Field
object
8 properties 8 required
LabelSelectionQuestionSettingsCreate
object
3 properties 2 required
TermsFilter
object
3 properties 3 required
VectorSettings
object
7 properties 7 required
FieldCreate
object
4 properties 3 required
SortOrder
string
SearchRecord
object
2 properties 1 required
ImageFieldSettings
object
1 property 1 required
ResponseMetrics
object
5 properties 5 required
HubDatasetMapping
object
4 properties 1 required
VectorsSettings
object
1 property 1 required
ChatFieldSettings
object
2 properties 2 required
ChatFieldSettingsCreate
object
2 properties 1 required
JobStatus
string
The Status of Job within its lifecycle at any given time.
SpanQuestionResponseValueItem
object
3 properties 3 required
LabelSelectionQuestionSettings
object
3 properties 2 required
Questions
object
1 property 1 required
DatasetStatus
string
SearchSuggestionOptionsQuestion
object
2 properties 2 required
SuggestionCreate
object
5 properties 2 required
RankingQuestionSettings
object
2 properties 2 required
Fields
object
1 property 1 required
QuestionCreate
object
5 properties 3 required
UserDraftResponseCreate
object
3 properties 3 required
TextQuery
object
2 properties 1 required
FloatMetadataProperty
object
3 properties 1 required
OptionSettings
object
3 properties 2 required
MetadataProperty
object
8 properties 8 required
RatingQuestionSettings
object
2 properties 2 required
ResponseValueCreate
object
1 property 1 required
DatasetOverlapDistributionCreate
object
2 properties 2 required
RecordResponseDistribution
object
3 properties
SpanQuestionSettings
object
6 properties 3 required
HubDatasetMappingItem
object
2 properties 2 required
RecordUpsert
object
7 properties
VectorQuery
object
4 properties 1 required
DatasetOverlapDistribution
object
2 properties 2 required
TextFieldSettings
object
2 properties 2 required
RankingQuestionResponseValueItem
object
2 properties 1 required
SearchSuggestionsOptions
object
1 property 1 required
OptionSettingsCreate
object
3 properties 2 required
RecordStatus
string
ResponseStatus
string
SuggestionType
string
MultiLabelSelectionQuestionSettingsCreate
object
4 properties 2 required
Question
object
9 properties 8 required
UserDiscardedResponseCreate
object
3 properties 2 required
Record
object
11 properties 6 required
DatasetCreate
object
6 properties 2 required
SpanQuestionSettingsCreate
object
5 properties 3 required
Job
object
2 properties 2 required
CustomFieldSettings
object
3 properties 3 required
RecordsBulkUpsert
object
1 property 1 required
RatingQuestionSettingsCreate
object
2 properties 2 required
ChatFieldValue
object
2 properties 2 required
UserProgress
object
3 properties 1 required
UsersProgress
object
1 property 1 required
TextFieldSettingsCreate
object
2 properties 1 required
RecordCreate
object
6 properties 1 required
SearchRecordsResult
object
2 properties 1 required
RangeFilter
object
4 properties 2 required
RankingQuestionSettingsCreate
object
2 properties 2 required
RatingQuestionSettingsOptionCreate
object
1 property 1 required
RatingQuestionSettingsOption
object
1 property 1 required
SuggestionFilterScope
object
3 properties 2 required
CustomFieldSettingsCreate
object
3 properties 2 required
Records
object
2 properties 1 required
ImageFieldSettingsCreate
object
1 property 1 required
UserSubmittedResponseCreate
object
3 properties 3 required
Query
object
2 properties
FloatMetadataPropertyCreate
object
3 properties 1 required
Dataset
object
11 properties 9 required
Response
object
7 properties 6 required
ResponseFilterScope
object
3 properties 1 required
MultiLabelSelectionQuestionSettings
object
4 properties 2 required
Order
object
2 properties 2 required
DatasetOverlapDistributionUpdate
object
2 properties 2 required
SearchRecordsQuery
object
3 properties
IntegerMetadataProperty
object
3 properties 1 required
HubDatasetExport
object
5 properties 2 required
MetadataPropertyCreate
object
4 properties 3 required
MetadataFilterScope
object
2 properties 2 required
OptionsOrder
string
Datasets
object
1 property 1 required
ResponseValue
object
1 property 1 required
VectorSettingsCreate
object
3 properties 3 required
Suggestion
object
8 properties 5 required
TermsMetadataProperty
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

argilla-datasets-api-openapi.yml Raw ↑

Other APIs Argilla publishes across the network.

Argilla Authentication API
Argilla fields API
Argilla info API
Argilla jobs API
Argilla metadata properties API
Argilla questions API
Argilla records API
Argilla responses API
Argilla settings API
Argilla suggestions API
Argilla users API
Argilla vectors-settings API
Where this information came from

This is an independent, third-party profile of Argilla datasets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.