CDISC-authored OpenAPI 3.1 specification for the Dataset-JSON API — studies, snapshots, datasets (including an NDJSON streaming representation and an $export operation) and Define-XML documents. This is a SPECIFICATION CDISC publishes for implementers to host, not a service CDISC operates: the contract declares no servers and CDISC runs no endpoint for it, which is why no baseURL is recorded.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cdisc-dataset-json-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"openapi": "3.1.0",
"info": {
"title": "Dataset-JSON",
"description": "CDISC Dataset-JSON Standard API",
"license": {
"name": "MIT",
"url": "https://opensource.org/license/mit/"
},
"version": "1.0"
},
"paths": {
"/about": {
"get": {
"summary": "Get About the API",
"operationId": "about_about_get",
"responses": {
"200": {
"description": "About the API",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/About"
}
}
}
}
}
}
},
"/studies": {
"get": {
"summary": "Get the list of studies",
"operationId": "studies_studies_get",
"parameters": [
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"200": {
"description": "The list of studies",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Studies"
},
"title": "Response Studies Studies Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"summary": "Create a new study",
"operationId": "add_study_studies_post",
"parameters": [
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudyRequest"
}
}
}
},
"responses": {
"201": {
"description": "The created study",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Study"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/studies/{studyOID}": {
"get": {
"summary": "Get a study",
"operationId": "study_studies__studyOID__get",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"200": {
"description": "The requested study",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Study"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"summary": "Update a study",
"operationId": "update_study_studies__studyOID__put",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudyRequest"
}
}
}
},
"responses": {
"200": {
"description": "The updated study",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Study"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"summary": "Delete a study",
"operationId": "delete_study_studies__studyOID__delete",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/studies/{studyOID}/snapshots": {
"post": {
"summary": "Create a new study snapshot",
"operationId": "add_snapshot_studies__studyOID__snapshots_post",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "label",
"in": "query",
"required": false,
"schema": {
"type": "string",
"title": "Label"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"201": {
"description": "Study snapshot created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Study"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"summary": "Get the list of snapshots for a study",
"operationId": "snapshots_studies__studyOID__snapshots_get",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"200": {
"description": "The list of snapshots for a study",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Snapshot"
},
"title": "Response Snapshots Studies Studyoid Snapshots Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/studies/{studyOID}/snapshots/{snapshotID}": {
"get": {
"summary": "Get a snapshot",
"operationId": "snapshot_studies__studyOID__snapshots__snapshotID__get",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "snapshotID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Snapshotid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"200": {
"description": "The requested snapshot",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Study"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"summary": "Delete a snapshot",
"operationId": "delete_snapshot_studies__studyOID__snapshots__snapshotID__delete",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "snapshotID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Snapshotid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/studies/{studyOID}/snapshots/{snapshotID}/datasets/{datasetOID}": {
"get": {
"summary": "Get a snapshot dataset",
"operationId": "dataset_studies__studyOID__snapshots__snapshotID__datasets__datasetOID__get",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "snapshotID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Snapshotid"
}
},
{
"name": "datasetOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Datasetoid"
}
},
{
"name": "metadataonly",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Metadataonly"
}
},
{
"name": "dataonly",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Dataonly"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Offset"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Limit"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
},
{
"name": "accept-encoding",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "Accept-Encoding"
}
},
{
"name": "if-modified-since",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "If-Modified-Since"
}
}
],
"responses": {
"200": {
"description": "The requested snapshot dataset content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetJson"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/studies/{studyOID}/datasets": {
"get": {
"summary": "Get the list of datasets for a study",
"operationId": "datasets_studies__studyOID__datasets_get",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "standard",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Standard"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
},
{
"name": "if-modified-since",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "If-Modified-Since"
}
}
],
"responses": {
"200": {
"description": "List of datasets for a study",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StudyDataset"
},
"title": "Response Datasets Studies Studyoid Datasets Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"summary": "Create a new dataset",
"operationId": "post_dataset_studies__studyOID__datasets_post",
"parameters": [
{
"name": "standard",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "Standard"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetJson"
}
}
}
},
"responses": {
"201": {
"description": "Study dataset metadata (not the entire dataset)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudyDataset"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/studies/{studyOID}/datasets/{datasetOID}": {
"get": {
"summary": "Get a dataset",
"operationId": "dataset_studies__studyOID__datasets__datasetOID__get",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "datasetOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Datasetoid"
}
},
{
"name": "metadataonly",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Metadataonly"
}
},
{
"name": "dataonly",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Dataonly"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Offset"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": 0,
"title": "Limit"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
},
{
"name": "accept-encoding",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "Accept-Encoding"
}
},
{
"name": "if-modified-since",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "If-Modified-Since"
}
}
],
"responses": {
"200": {
"description": "The requested dataset content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetJson"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"summary": "Update a dataset",
"operationId": "update_dataset_studies__studyOID__datasets__datasetOID__put",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "datasetOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Datasetoid"
}
},
{
"name": "standard",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "Standard"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetJson"
}
}
}
},
"responses": {
"200": {
"description": "Updated dataset metadata (not the entire dataset)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudyDataset"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"summary": "Append records to a dataset",
"operationId": "append_dataset_studies__studyOID__datasets__datasetOID__patch",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "datasetOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Datasetoid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RowData"
}
}
}
},
"responses": {
"200": {
"description": "Updated dataset metadata (not the entire dataset)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudyDataset"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"summary": "Delete a dataset",
"operationId": "delete_dataset_studies__studyOID__datasets__datasetOID__delete",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "datasetOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Datasetoid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/studies/{studyOID}/datasets/{datasetOID}/$export": {
"get": {
"summary": "Export a dataset to NDJSON (async)",
"operationId": "export_dataset_studies__studyOID__datasets__datasetOID___export_get",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "datasetOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Datasetoid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
}
],
"responses": {
"202": {
"description": "A link to retrieve the exported NDJSON dataset",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Link"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/studies/{studyOID}/datasets/{datasetOID}/ndjson": {
"get": {
"summary": "Download NDJSON dataset as a stream",
"operationId": "download_dataset_stream_studies__studyOID__datasets__datasetOID__ndjson_get",
"parameters": [
{
"name": "studyOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Studyoid"
}
},
{
"name": "datasetOID",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Datasetoid"
}
},
{
"name": "api-key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"title": "Api-Key"
}
},
{
"name": "accept-encoding",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": "",
"title": "Accept-Encoding"
}
}
],
"responses": {
"200": {
"description": "NDJSON stream",
"content": {
"application/x-ndjson": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/DatasetJsonMetadata"
},
{
"$ref": "#/components/schemas/OneRowData"
}
]
}
}
}
},
"422": {
"description": "Validation E
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cdisc/refs/heads/main/openapi/cdisc-dataset-json-api-openapi.json