Kaggle OpenAPI (Converted from Swagger)

kaggle-openapi.json

{
"openapi": "3.0.1",
"info": {
"title": "Kaggle API",
"description": "API for kaggle.com",
"termsOfService": "https://www.kaggle.com/terms",
"contact": {
"name": "Contact Kaggle",
"url": "https://www.kaggle.com/contact"
},
"version": "1"
},
"externalDocs": {
"description": "Further Kaggle documentation",
"url": "www.kaggle.com"
},
"servers": [
{
"url": "https://www.kaggle.com/api/v1"
}
],
"security": [
{
"basicAuth": []
}
],
"tags": [
{
"name": "kaggle"
}
],
"paths": {
"/competitions/list": {
"get": {
"tags": [
"kaggle"
],
"summary": "List competitions",
"operationId": "CompetitionsList",
"parameters": [
{
"name": "group",
"in": "query",
"description": "Filter competitions by a particular group",
"schema": {
"type": "string",
"default": "general",
"enum": [
"general",
"entered",
"inClass"
]
}
},
{
"name": "category",
"in": "query",
"description": "Filter competitions by a particular category",
"schema": {
"type": "string",
"default": "all",
"enum": [
"all",
"featured",
"research",
"recruitment",
"gettingStarted",
"masters",
"playground"
]
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort the results",
"schema": {
"type": "string",
"default": "latestDeadline",
"enum": [
"grouped",
"prize",
"earliestDeadline",
"latestDeadline",
"numberOfTeams",
"recentlyCreated"
]
}
},
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "search",
"in": "query",
"description": "Search terms",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/submissions/list/{id}": {
"get": {
"tags": [
"kaggle"
],
"summary": "List competition submissions",
"operationId": "CompetitionsSubmissionsList",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Competition name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"default": 1
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/{id}/submissions/url/{contentLength}/{lastModifiedDateUtc}": {
"post": {
"tags": [
"kaggle"
],
"summary": "Generate competition submission URL",
"operationId": "CompetitionsSubmissionsUrl",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Competition name, as it appears in the competition's URL",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentLength",
"in": "path",
"description": "Content length of file in bytes",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lastModifiedDateUtc",
"in": "path",
"description": "Last modified date of file in seconds since epoch in UTC",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"description": "Competition submission file name"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/submissions/upload/{guid}/{contentLength}/{lastModifiedDateUtc}": {
"post": {
"tags": [
"kaggle"
],
"summary": "Upload competition submission file",
"operationId": "CompetitionsSubmissionsUpload",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "Location where submission should be uploaded",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contentLength",
"in": "path",
"description": "Content length of file in bytes",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lastModifiedDateUtc",
"in": "path",
"description": "Last modified date of file in seconds since epoch in UTC",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "Competition submission file",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/submissions/submit/{id}": {
"post": {
"tags": [
"kaggle"
],
"summary": "Submit to competition",
"operationId": "CompetitionsSubmissionsSubmit",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Competition name",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"blobFileTokens",
"submissionDescription"
],
"type": "object",
"properties": {
"blobFileTokens": {
"type": "string",
"description": "Token identifying location of uploaded submission file"
},
"submissionDescription": {
"type": "string",
"description": "Description of competition submission"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/data/list/{id}": {
"get": {
"tags": [
"kaggle"
],
"summary": "List competition data files",
"operationId": "CompetitionsDataListFiles",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Competition name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pageToken",
"in": "query",
"description": "Page token for pagination",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page (default 20)",
"schema": {
"type": "integer",
"default": 20
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/data/download/{id}/{fileName}": {
"get": {
"tags": [
"kaggle"
],
"summary": "Download competition data file",
"operationId": "CompetitionsDataDownloadFile",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Competition name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileName",
"in": "path",
"description": "Competition name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/data/download-all/{id}": {
"get": {
"tags": [
"kaggle"
],
"summary": "Download all competition data files",
"operationId": "CompetitionsDataDownloadFiles",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Competition name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/{id}/leaderboard/download": {
"get": {
"tags": [
"kaggle"
],
"summary": "Download competition leaderboard",
"operationId": "CompetitionDownloadLeaderboard",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Competition name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/competitions/{id}/leaderboard/view": {
"get": {
"tags": [
"kaggle"
],
"summary": "VIew competition leaderboard",
"operationId": "CompetitionViewLeaderboard",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Competition name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/datasets/list": {
"get": {
"tags": [
"kaggle"
],
"summary": "List datasets",
"operationId": "DatasetsList",
"parameters": [
{
"name": "group",
"in": "query",
"description": "Display datasets by a particular group",
"schema": {
"type": "string",
"default": "public",
"enum": [
"public",
"my",
"myPrivate",
"upvoted",
"user"
]
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort the results",
"schema": {
"type": "string",
"default": "hottest",
"enum": [
"hottest",
"votes",
"updated",
"active"
]
}
},
{
"name": "size",
"in": "query",
"description": "(DEPRECATED). Please use --max-size and --min-size to filter dataset sizes.",
"schema": {
"type": "string",
"default": "all"
}
},
{
"name": "filetype",
"in": "query",
"description": "Display datasets of a specific file type",
"schema": {
"type": "string",
"default": "all",
"enum": [
"all",
"csv",
"sqlite",
"json",
"bigQuery"
]
}
},
{
"name": "license",
"in": "query",
"description": "Display datasets with a specific license",
"schema": {
"type": "string",
"default": "all",
"enum": [
"all",
"cc",
"gpl",
"odb",
"other"
]
}
},
{
"name": "tagids",
"in": "query",
"description": "A comma separated list of tags to filter by",
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"description": "Search terms",
"schema": {
"type": "string"
}
},
{
"name": "user",
"in": "query",
"description": "Display datasets by a specific user or organization",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "maxSize",
"in": "query",
"description": "Max Dataset Size (bytes)",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "minSize",
"in": "query",
"description": "Max Dataset Size (bytes)",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/datasets/list/{ownerSlug}/{datasetSlug}": {
"get": {
"tags": [
"kaggle"
],
"summary": "List dataset files",
"operationId": "DatasetsListFiles",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Dataset owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetSlug",
"in": "path",
"description": "Dataset name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetVersionNumber",
"in": "query",
"description": "Dataset version number",
"schema": {
"type": "string"
}
},
{
"name": "pageToken",
"in": "query",
"description": "Page token for pagination",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page (default 20)",
"schema": {
"type": "integer",
"default": 20
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/datasets/status/{ownerSlug}/{datasetSlug}": {
"get": {
"tags": [
"kaggle"
],
"summary": "Get dataset creation status",
"operationId": "DatasetsStatus",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Dataset owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetSlug",
"in": "path",
"description": "Dataset name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/datasets/download/{ownerSlug}/{datasetSlug}": {
"get": {
"tags": [
"kaggle"
],
"summary": "Download dataset file",
"operationId": "DatasetsDownload",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Dataset owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetSlug",
"in": "path",
"description": "Dataset name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetVersionNumber",
"in": "query",
"description": "Dataset version number",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"file": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"file": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/datasets/download/{ownerSlug}/{datasetSlug}/{fileName}": {
"get": {
"tags": [
"kaggle"
],
"summary": "Download dataset file",
"operationId": "DatasetsDownloadFile",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Dataset owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetSlug",
"in": "path",
"description": "Dataset name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileName",
"in": "path",
"description": "File name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetVersionNumber",
"in": "query",
"description": "Dataset version number",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"file": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"file": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/datasets/create/version/{id}": {
"post": {
"tags": [
"kaggle"
],
"summary": "Create a new dataset version by id",
"operationId": "DatasetsCreateVersionById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"description": "Information for creating a new dataset version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetNewVersionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "datasetNewVersionRequest"
}
},
"/datasets/create/version/{ownerSlug}/{datasetSlug}": {
"post": {
"tags": [
"kaggle"
],
"summary": "Create a new dataset version",
"operationId": "DatasetsCreateVersion",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Dataset owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetSlug",
"in": "path",
"description": "Dataset name",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Information for creating a new dataset version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetNewVersionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "datasetNewVersionRequest"
}
},
"/datasets/create/new": {
"post": {
"tags": [
"kaggle"
],
"summary": "Create a new dataset",
"operationId": "DatasetsCreateNew",
"requestBody": {
"description": "Information for creating a new dataset",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetNewRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "datasetNewRequest"
}
},
"/kernels/list": {
"get": {
"tags": [
"kaggle"
],
"summary": "List kernels",
"operationId": "KernelsList",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Page number",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page (default 20)",
"schema": {
"type": "integer",
"default": 20
}
},
{
"name": "search",
"in": "query",
"description": "Search terms",
"schema": {
"type": "string"
}
},
{
"name": "group",
"in": "query",
"description": "Display only your kernels",
"schema": {
"type": "string",
"default": "everyone",
"enum": [
"everyone",
"profile",
"upvoted"
]
}
},
{
"name": "user",
"in": "query",
"description": "Display kernels by a particular group",
"schema": {
"type": "string"
}
},
{
"name": "language",
"in": "query",
"description": "Display kernels in a specific language",
"schema": {
"type": "string",
"default": "all",
"enum": [
"all",
"python",
"r",
"sqlite",
"julia"
]
}
},
{
"name": "kernelType",
"in": "query",
"description": "Display kernels of a specific type",
"schema": {
"type": "string",
"default": "all",
"enum": [
"all",
"script",
"notebook"
]
}
},
{
"name": "outputType",
"in": "query",
"description": "Display kernels with a specific output type",
"schema": {
"type": "string",
"default": "all",
"enum": [
"all",
"visualization",
"data"
]
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort the results. 'relevance' only works if there is a search query",
"schema": {
"type": "string",
"default": "hotness",
"enum": [
"hotness",
"commentCount",
"dateCreated",
"dateRun",
"scoreAscending",
"scoreDescending",
"viewCount",
"voteCount",
"relevance"
]
}
},
{
"name": "dataset",
"in": "query",
"description": "Display kernels using the specified dataset",
"schema": {
"type": "string"
}
},
{
"name": "competition",
"in": "query",
"description": "Display kernels using the specified competition",
"schema": {
"type": "string"
}
},
{
"name": "parentKernel",
"in": "query",
"description": "Display kernels that have forked the specified kernel",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/kernels/files": {
"get": {
"tags": [
"kaggle"
],
"summary": "List kernel files",
"operationId": "KernelsListFiles",
"parameters": [
{
"name": "userName",
"in": "query",
"description": "Kernel owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "kernelSlug",
"in": "query",
"description": "Kernel name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "kernelVersionNumber",
"in": "query",
"description": "Kernel version number",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page (default 20)",
"schema": {
"type": "integer",
"default": 20
}
},
{
"name": "pageToken",
"in": "query",
"description": "Page token for pagination",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/kernels/push": {
"post": {
"tags": [
"kaggle"
],
"summary": "Push a new kernel version.  Can be used to create a new kernel and update an existing one.",
"operationId": "KernelPush",
"requestBody": {
"description": "Information for pushing a new kernel version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KernelPushRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "kernelPushRequest"
}
},
"/kernels/pull": {
"get": {
"tags": [
"kaggle"
],
"summary": "Pull the latest code from a kernel",
"operationId": "KernelPull",
"parameters": [
{
"name": "userName",
"in": "query",
"description": "Kernel owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "kernelSlug",
"in": "query",
"description": "Kernel name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/kernels/output": {
"get": {
"tags": [
"kaggle"
],
"summary": "Download the latest output from a kernel",
"operationId": "KernelOutput",
"parameters": [
{
"name": "userName",
"in": "query",
"description": "Kernel owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "kernelSlug",
"in": "query",
"description": "Kernel name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/kernels/status": {
"get": {
"tags": [
"kaggle"
],
"summary": "Get the status of the latest kernel version",
"operationId": "KernelStatus",
"parameters": [
{
"name": "userName",
"in": "query",
"description": "Kernel owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "kernelSlug",
"in": "query",
"description": "Kernel name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/datasets/metadata/{ownerSlug}/{datasetSlug}": {
"get": {
"tags": [
"kaggle"
],
"summary": "Get the metadata for a dataset",
"operationId": "MetadataGet",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Dataset owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetSlug",
"in": "path",
"description": "Dataset name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"tags": [
"kaggle"
],
"summary": "Update the metadata for a dataset",
"operationId": "MetadataPost",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Dataset owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "datasetSlug",
"in": "path",
"description": "Dataset name",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Dataset metadata to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetUpdateSettingsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "settings"
}
},
"/models/{ownerSlug}/{modelSlug}/get": {
"get": {
"tags": [
"kaggle"
],
"summary": "Get a model",
"operationId": "GetModel",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/models/list": {
"get": {
"tags": [
"kaggle"
],
"summary": "Lists models",
"operationId": "ModelsList",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Search terms",
"schema": {
"type": "string"
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort the results",
"schema": {
"type": "string",
"default": "hotness",
"enum": [
"hotness",
"downloadCount",
"voteCount",
"notebookCount",
"publishTime",
"createTime",
"updateTime"
]
}
},
{
"name": "owner",
"in": "query",
"description": "Display models by a specific user or organization",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page (default 20)",
"schema": {
"type": "integer",
"default": 20
}
},
{
"name": "pageToken",
"in": "query",
"description": "Page token for pagination",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/models/{ownerSlug}/{modelSlug}/{framework}/{instanceSlug}/files": {
"get": {
"tags": [
"kaggle"
],
"summary": "List model instance files for the current version",
"operationId": "ModelInstanceFiles",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "framework",
"in": "path",
"description": "Model instance framework",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "instanceSlug",
"in": "path",
"description": "Model instance slug",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page (default 20)",
"schema": {
"type": "integer",
"default": 20
}
},
{
"name": "pageToken",
"in": "query",
"description": "Page token for pagination",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/models/create/new": {
"post": {
"tags": [
"kaggle"
],
"summary": "Create a new model",
"operationId": "ModelsCreateNew",
"requestBody": {
"description": "Information for creating a new model",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/modelNewRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "modelNewRequest"
}
},
"/models/{ownerSlug}/{modelSlug}/{framework}/{instanceSlug}/get": {
"get": {
"tags": [
"kaggle"
],
"summary": "Get a model instance",
"operationId": "GetModelInstance",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "framework",
"in": "path",
"description": "Model instance framework",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "instanceSlug",
"in": "path",
"description": "Model instance slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/models/{ownerSlug}/{modelSlug}/create/instance": {
"post": {
"tags": [
"kaggle"
],
"summary": "Create a new model instance",
"operationId": "ModelsCreateInstance",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Information for creating a new model instance",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelNewInstanceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "ModelNewInstanceRequest"
}
},
"/models/{ownerSlug}/{modelSlug}/{framework}/{instanceSlug}/create/version": {
"post": {
"tags": [
"kaggle"
],
"summary": "Create a new model instance version",
"operationId": "ModelsCreateInstanceVersion",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model slug",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "framework",
"in": "path",
"description": "Model instance framework",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "instanceSlug",
"in": "path",
"description": "Model instance slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Information for creating a new model instance version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelInstanceNewVersionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "ModelInstanceNewVersionRequest"
}
},
"/models/{ownerSlug}/{modelSlug}/delete": {
"post": {
"tags": [
"kaggle"
],
"summary": "Delete a model",
"operationId": "DeleteModel",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/models/{ownerSlug}/{modelSlug}/{framework}/{instanceSlug}/delete": {
"post": {
"tags": [
"kaggle"
],
"summary": "Delete a model instance",
"operationId": "DeleteModelInstance",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "framework",
"in": "path",
"description": "Model instance framework",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "instanceSlug",
"in": "path",
"description": "Model instance slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/models/{ownerSlug}/{modelSlug}/{framework}/{instanceSlug}/{versionNumber}/delete": {
"post": {
"tags": [
"kaggle"
],
"summary": "Delete a model instance version",
"operationId": "DeleteModelInstanceVersion",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "framework",
"in": "path",
"description": "Model instance framework",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "instanceSlug",
"in": "path",
"description": "Model instance slug",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Model instance version number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/models/{ownerSlug}/{modelSlug}/update": {
"post": {
"tags": [
"kaggle"
],
"summary": "Update a model",
"operationId": "UpdateModel",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Information for updating a model",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/modelUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "modelUpdateRequest"
}
},
"/models/{ownerSlug}/{modelSlug}/{framework}/{instanceSlug}/update": {
"post": {
"tags": [
"kaggle"
],
"summary": "Update a model",
"operationId": "UpdateModelInstance",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "framework",
"in": "path",
"description": "Model instance framework",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "instanceSlug",
"in": "path",
"description": "Model instance slug",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Information for updating a model instance",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/modelInstanceUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "modelInstanceUpdateRequest"
}
},
"/models/{ownerSlug}/{modelSlug}/{framework}/{instanceSlug}/{versionNumber}/download": {
"get": {
"tags": [
"kaggle"
],
"summary": "Download model instance version files",
"operationId": "ModelInstanceVersionsDownload",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "framework",
"in": "path",
"description": "Model instance framework",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "instanceSlug",
"in": "path",
"description": "Model instance slug",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Model instance version number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"file": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"file": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/models/{ownerSlug}/{modelSlug}/{framework}/{instanceSlug}/{versionNumber}/files": {
"get": {
"tags": [
"kaggle"
],
"summary": "List model instance version files",
"operationId": "ModelInstanceVersionFiles",
"parameters": [
{
"name": "ownerSlug",
"in": "path",
"description": "Model owner",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "modelSlug",
"in": "path",
"description": "Model name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "framework",
"in": "path",
"description": "Model instance framework",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "instanceSlug",
"in": "path",
"description": "Model instance slug",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Model instance version number",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items per page (default 20)",
"schema": {
"type": "integer",
"default": 20
}
},
{
"name": "pageToken",
"in": "query",
"description": "Page token for pagination",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/blobs/upload": {
"post": {
"tags": [
"kaggle"
],
"summary": "Start uploading a file",
"operationId": "UploadFile",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartBlobUploadRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "StartBlobUploadResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartBlobUploadResponse"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "startBlobUploadRequest"
}
},
"/inbox/files/create": {
"post": {
"tags": [
"kaggle"
],
"summary": "Creates (aka \"drops\") a new file into the inbox.",
"operationId": "CreateInboxFile",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInboxFileRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Result"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"x-codegen-request-body-name": "createInboxFileRequest"
}
}
},
"components": {
"schemas": {
"Result": {
"type": "object"
},
"Error": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "The server error code returned",
"example": 404
},
"message": {
"type": "string",
"description": "The error message generated by the server",
"example": "NotFound"
}
}
},
"DatasetColumn": {
"type": "object",
"properties": {
"order": {
"type": "number",
"description": "The order that the column comes in, 0-based. (The first column is 0, second is 1, etc.)"
},
"name": {
"type": "string",
"description": "The column name"
},
"type": {
"type": "string",
"description": "The type of all of the fields in the column. Please see the data types on https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata"
},
"originalType": {
"type": "string",
"description": "Used to store the original type of the column, which will be converted to Kaggle's types. For example, an `originalType` of `\"integer\"` would convert to a `type` of `\"numeric\"`"
},
"description": {
"type": "string",
"description": "The description of the column"
}
}
},
"UploadFile": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "A token referencing a specific file upload that can be used across requests"
},
"description": {
"type": "string",
"description": "The file description"
},
"columns": {
"type": "array",
"description": "A list of dataset column metadata",
"items": {
"$ref": "#/components/schemas/DatasetColumn"
}
}
}
},
"DatasetNewVersionRequest": {
"required": [
"files",
"versionNotes"
],
"type": "object",
"properties": {
"versionNotes": {
"type": "string",
"description": "The version notes for the new dataset version"
},
"subtitle": {
"type": "string",
"description": "The subtitle to set on the dataset"
},
"description": {
"type": "string",
"description": "The description to set on the dataset"
},
"files": {
"type": "array",
"description": "A list of files that should be associated with the dataset",
"items": {
"$ref": "#/components/schemas/UploadFile"
}
},
"convertToCsv": {
"type": "boolean",
"description": "Whether or not a tabular dataset should be converted to csv",
"default": true
},
"categoryIds": {
"type": "array",
"description": "A list of tag IDs to associated with the dataset",
"items": {
"type": "string"
}
},
"deleteOldVersions": {
"type": "boolean",
"description": "Whether or not all previous versions of the dataset should be deleted upon creating the new version",
"default": false
}
}
},
"DatasetNewRequest": {
"required": [
"files",
"title"
],
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the new dataset"
},
"slug": {
"type": "string",
"description": "The slug that the dataset should be created with"
},
"ownerSlug": {
"type": "string",
"description": "The owner's username"
},
"licenseName": {
"type": "string",
"description": "The license that should be associated with the dataset",
"default": "unknown",
"enum": [
"CC0-1.0",
"CC-BY-SA-4.0",
"GPL-2.0",
"ODbL-1.0",
"CC-BY-NC-SA-4.0",
"unknown",
"DbCL-1.0",
"CC-BY-SA-3.0",
"copyright-authors",
"other",
"reddit-api",
"world-bank",
"CC-BY-4.0",
"CC-BY-NC-4.0",
"PDDL",
"CC-BY-3.0",
"CC-BY-3.0-IGO",
"US-Government-Works",
"CC-BY-NC-SA-3.0-IGO",
"CDLA-Permissive-1.0",
"CDLA-Sharing-1.0",
"CC-BY-ND-4.0",
"CC-BY-NC-ND-4.0",
"ODC-BY-1.0",
"LGPL-3.0",
"AGPL-3.0",
"FDL-1.3",
"EU-ODP-Legal-Notice",
"apache-2.0",
"GPL-3.0"
]
},
"subtitle": {
"type": "string",
"description": "The subtitle to be set on the dataset"
},
"description": {
"type": "string",
"description": "The description to be set on the dataset",
"default": ""
},
"files": {
"type": "array",
"description": "A list of files that should be associated with the dataset",
"items": {
"$ref": "#/components/schemas/UploadFile"
}
},
"isPrivate": {
"type": "boolean",
"description": "Whether or not the dataset should be private",
"default": true
},
"convertToCsv": {
"type": "boolean",
"description": "Whether or not a tabular dataset should be converted to csv",
"default": true
},
"categoryIds": {
"type": "array",
"description": "A list of tag IDs to associated with the dataset",
"items": {
"type": "string"
}
}
}
},
"KernelPushRequest": {
"required": [
"kernelType",
"language",
"text"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The kernel's ID number. One of `id` and `slug` are required. If both are specified, `id` will be preferred"
},
"slug": {
"type": "string",
"description": "The full slug of the kernel to push to, in the format `USERNAME/KERNEL-SLUG`. The kernel slug must be the title lowercased with dashes (`-`) replacing spaces. One of `id` and `slug` are required. If both are specified, `id` will be preferred"
},
"newTitle": {
"type": "string",
"description": "The title to be set on the kernel"
},
"text": {
"type": "string",
"description": "The kernel's source code"
},
"language": {
"type": "string",
"description": "The language that the kernel is written in",
"enum": [
"python",
"r",
"rmarkdown"
]
},
"kernelType": {
"type": "string",
"description": "The type of kernel. Cannot be changed once the kernel has been created",
"enum": [
"script",
"notebook"
]
},
"isPrivate": {
"type": "boolean",
"description": "Whether or not the kernel should be private"
},
"enableGpu": {
"type": "boolean",
"description": "Whether or not the kernel should run on a GPU"
},
"enableTpu": {
"type": "boolean",
"description": "Whether or not the kernel should run on a TPU"
},
"enableInternet": {
"type": "boolean",
"description": "Whether or not the kernel should be able to access the internet"
},
"datasetDataSources": {
"type": "array",
"description": "A list of dataset data sources that the kernel should use. Each dataset is specified as `USERNAME/DATASET-SLUG`",
"items": {
"type": "string"
}
},
"competitionDataSources": {
"type": "array",
"description": "A list of competition data sources that the kernel should use",
"items": {
"type": "string"
}
},
"kernelDataSources": {
"type": "array",
"description": "A list of kernel data sources that the kernel should use. Each dataset is specified as `USERNAME/KERNEL-SLUG`",
"items": {
"type": "string"
}
},
"modelDataSources": {
"type": "array",
"description": "A list of model data sources that the kernel should use. Each model is specified as `USERNAME/MODEL-SLUG/FRAMEWORK/VARIATION-SLUG/VERSION-NUMBER`",
"items": {
"type": "string"
}
},
"categoryIds": {
"type": "array",
"description": "A list of tag IDs to associated with the kernel",
"items": {
"type": "string"
}
},
"dockerImagePinningType": {
"type": "string",
"description": "Which docker image to use for executing new versions going forward.",
"enum": [
"original",
"latest"
]
}
}
},
"DatasetUpdateSettingsRequest": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the dataset"
},
"subtitle": {
"type": "string",
"description": "Subtitle of the dataset"
},
"description": {
"type": "string",
"description": "Decription of the dataset"
},
"isPrivate": {
"type": "boolean",
"description": "Whether or not the dataset should be private"
},
"licenses": {
"type": "array",
"description": "A list of licenses that apply to this dataset",
"items": {
"type": "object",
"properties": {}
}
},
"keywords": {
"type": "array",
"description": "A list of keywords that apply to this dataset",
"items": {
"type": "string"
}
},
"collaborators": {
"type": "array",
"description": "A list of collaborators that may read or edit this dataset",
"items": {
"type": "object",
"properties": {}
}
},
"data": {
"type": "array",
"description": "A list containing metadata for each file in the dataset",
"items": {
"type": "object",
"properties": {}
}
}
}
},
"License": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the license",
"enum": [
"CC0-1.0",
"CC-BY-SA-4.0",
"GPL-2.0",
"ODbL-1.0",
"CC-BY-NC-SA-4.0",
"unknown",
"DbCL-1.0",
"CC-BY-SA-3.0",
"copyright-authors",
"other",
"reddit-api",
"world-bank",
"CC-BY-4.0",
"CC-BY-NC-4.0",
"PDDL",
"CC-BY-3.0",
"CC-BY-3.0-IGO",
"US-Government-Works",
"CC-BY-NC-SA-3.0-IGO",
"CDLA-Permissive-1.0",
"CDLA-Sharing-1.0",
"CC-BY-ND-4.0",
"CC-BY-NC-ND-4.0",
"ODC-BY-1.0",
"LGPL-3.0",
"AGPL-3.0",
"FDL-1.3",
"EU-ODP-Legal-Notice",
"apache-2.0",
"GPL-3.0"
]
}
}
},
"Collaborator": {
"required": [
"role",
"username"
],
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "Username of the collaborator"
},
"role": {
"type": "string",
"description": "Role of the collaborator",
"enum": [
"reader",
"writer"
]
}
}
},
"ModelNewRequest": {
"required": [
"isPrivate",
"ownerSlug",
"slug",
"title"
],
"type": "object",
"properties": {
"ownerSlug": {
"type": "string",
"description": "The owner's slug"
},
"slug": {
"type": "string",
"description": "The slug that the model should be created with"
},
"title": {
"type": "string",
"description": "The title of the new model"
},
"subtitle": {
"type": "string",
"description": "The subtitle of the new model"
},
"isPrivate": {
"type": "boolean",
"description": "Whether or not the model should be private",
"default": true
},
"description": {
"type": "string",
"description": "The description to be set on the model",
"default": ""
},
"publishTime": {
"type": "string",
"description": "When the model was initially published",
"format": "date"
},
"provenanceSources": {
"type": "string",
"description": "The provenance sources to be set on the model",
"default": ""
}
}
},
"ModelUpdateRequest": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the new model"
},
"subtitle": {
"type": "string",
"description": "The subtitle of the new model"
},
"isPrivate": {
"type": "boolean",
"description": "Whether or not the model should be private",
"default": true
},
"description": {
"type": "string",
"description": "The description to be set on the model",
"default": ""
},
"publishTime": {
"type": "string",
"description": "When the model was initially published",
"format": "date"
},
"provenanceSources": {
"type": "string",
"description": "The provenance sources to be set on the model",
"default": ""
},
"updateMask": {
"type": "string",
"description": "Describes which fields to update"
}
}
},
"ModelNewInstanceRequest": {
"required": [
"framework",
"instanceSlug",
"licenseName"
],
"type": "object",
"properties": {
"instanceSlug": {
"type": "string",
"description": "The slug that the model instance should be created with"
},
"framework": {
"type": "string",
"description": "The framework of the model instance",
"enum": [
"tensorFlow1",
"tensorFlow2",
"tfLite",
"tfJs",
"pyTorch",
"jax",
"flax",
"pax",
"maxText",
"gemmaCpp",
"tensorRtLlm",
"ggml",
"gguf",
"coral",
"scikitLearn",
"mxnet",
"onnx",
"keras",
"transformers",
"triton",
"other"
]
},
"overview": {
"type": "string",
"description": "The overview of the model instance (markdown)"
},
"usage": {
"type": "string",
"description": "The description of how to use the model instance (markdown)"
},
"licenseName": {
"type": "string",
"description": "The license that should be associated with the model instance",
"default": "Apache 2.0",
"enum": [
"CC0 1.0",
"CC BY-NC-SA 4.0",
"Unknown",
"CC BY-SA 4.0",
"GPL 2",
"CC BY-SA 3.0",
"Other",
"Other (specified in description)",
"CC BY 4.0",
"Attribution 4.0 International (CC BY 4.0)",
"CC BY-NC 4.0",
"Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)",
"PDDL",
"ODC Public Domain Dedication and Licence (PDDL)",
"CC BY 3.0",
"Attribution 3.0 Unported (CC BY 3.0)",
"CC BY 3.0 IGO",
"Attribution 3.0 IGO (CC BY 3.0 IGO)",
"CC BY-NC-SA 3.0 IGO",
"Attribution-NonCommercial-ShareAlike 3.0 IGO (CC BY-NC-SA 3.0 IGO)",
"CDLA Permissive 1.0",
"Community Data License Agreement - Permissive - Version 1.0",
"CDLA Sharing 1.0",
"Community Data License Agreement - Sharing - Version 1.0",
"CC BY-ND 4.0",
"Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)",
"CC BY-NC-ND 4.0",
"Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0)",
"ODC-BY 1.0",
"ODC Attribution License (ODC-By)",
"LGPL 3.0",
"GNU Lesser General Public License 3.0",
"AGPL 3.0",
"GNU Affero General Public License 3.0",
"FDL 1.3",
"GNU Free Documentation License 1.3",
"apache-2.0",
"Apache 2.0",
"mit",
"MIT",
"bsd-3-clause",
"BSD-3-Clause",
"Llama 2",
"Llama 2 Community License",
"Gemma",
"gpl-3",
"GPL 3",
"RAIL-M",
"AI Pubs Open RAIL-M License",
"AIPubs Research-Use RAIL-M",
"AI Pubs Research-Use RAIL-M License",
"BigScience OpenRAIL-M",
"BigScience Open RAIL-M License",
"RAIL",
"RAIL (specified in description)",
"Llama 3",
"Llama 3 Community License"
]
},
"fineTunable": {
"type": "boolean",
"description": "Whether the model instance is fine tunable",
"default": true
},
"trainingData": {
"type": "array",
"description": "A list of training data (urls or names)",
"items": {
"type": "string"
}
},
"modelInstanceType": {
"type": "string",
"description": "Whether the model instance is a base model, external variant, internal variant, or unspecified",
"enum": [
"Unspecified",
"BaseModel",
"KaggleVariant",
"ExternalVariant"
]
},
"baseModelInstance": {
"type": "string",
"description": "If this is an internal variant, the `{owner-slug}/{model-slug}/{framework}/{instance-slug}` of the base model instance"
},
"externalBaseModelUrl": {
"type": "integer",
"description": "If this is an external variant, a URL to the base model"
},
"files": {
"type": "array",
"description": "A list of files that should be associated with the model instance version",
"items": {
"$ref": "#/components/schemas/UploadFile"
}
}
}
},
"ModelInstanceUpdateRequest": {
"required": [
"updateMask"
],
"type": "object",
"properties": {
"overview": {
"type": "string",
"description": "The overview of the model instance (markdown)"
},
"usage": {
"type": "string",
"description": "The description of how to use the model instance (markdown)"
},
"licenseName": {
"type": "string",
"description": "The license that should be associated with the model instance",
"default": "Apache 2.0",
"enum": [
"CC0 1.0",
"CC BY-NC-SA 4.0",
"Unknown",
"CC BY-SA 4.0",
"GPL 2",
"CC BY-SA 3.0",
"Other",
"Other (specified in description)",
"CC BY 4.0",
"Attribution 4.0 International (CC BY 4.0)",
"CC BY-NC 4.0",
"Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)",
"PDDL",
"ODC Public Domain Dedication and Licence (PDDL)",
"CC BY 3.0",
"Attribution 3.0 Unported (CC BY 3.0)",
"CC BY 3.0 IGO",
"Attribution 3.0 IGO (CC BY 3.0 IGO)",
"CC BY-NC-SA 3.0 IGO",
"Attribution-NonCommercial-ShareAlike 3.0 IGO (CC BY-NC-SA 3.0 IGO)",
"CDLA Permissive 1.0",
"Community Data License Agreement - Permissive - Version 1.0",
"CDLA Sharing 1.0",
"Community Data License Agreement - Sharing - Version 1.0",
"CC BY-ND 4.0",
"Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)",
"CC BY-NC-ND 4.0",
"Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0)",
"ODC-BY 1.0",
"ODC Attribution License (ODC-By)",
"LGPL 3.0",
"GNU Lesser General Public License 3.0",
"AGPL 3.0",
"GNU Affero General Public License 3.0",
"FDL 1.3",
"GNU Free Documentation License 1.3",
"apache-2.0",
"Apache 2.0",
"mit",
"MIT",
"bsd-3-clause",
"BSD-3-Clause",
"Llama 2",
"Llama 2 Community License",
"Gemma",
"gpl-3",
"GPL 3",
"RAIL-M",
"AI Pubs Open RAIL-M License",
"AIPubs Research-Use RAIL-M",
"AI Pubs Research-Use RAIL-M License",
"BigScience OpenRAIL-M",
"BigScience Open RAIL-M License",
"RAIL",
"RAIL (specified in description)",
"Llama 3",
"Llama 3 Community License"
]
},
"fineTunable": {
"type": "boolean",
"description": "Whether the model instance is fine tunable",
"default": true
},
"trainingData": {
"type": "array",
"description": "A list of training data (urls or names)",
"items": {
"type": "string"
}
},
"modelInstanceType": {
"type": "string",
"description": "Whether the model instance is a base model, external variant, internal variant, or unspecified",
"enum": [
"Unspecified",
"BaseModel",
"KaggleVariant",
"ExternalVariant"
]
},
"baseModelInstance": {
"type": "string",
"description": "If this is an internal variant, the `{owner-slug}/{model-slug}/{framework}/{instance-slug}` of the base model instance"
},
"externalBaseModelUrl": {
"type": "integer",
"description": "If this is an external variant, a URL to the base model"
},
"updateMask": {
"type": "string",
"description": "Describes which fields to update"
}
}
},
"ModelInstanceNewVersionRequest": {
"required": [
"files"
],
"type": "object",
"properties": {
"versionNotes": {
"type": "string",
"description": "The version notes for the model instance version"
},
"files": {
"type": "array",
"description": "A list of files that should be associated with the model instance version",
"items": {
"$ref": "#/components/schemas/UploadFile"
}
}
}
},
"StartBlobUploadRequest": {
"required": [
"contentLength",
"name"
],
"type": "object",
"properties": {
"type": {
"type": "object",
"properties": {},
"description": "The type of the blob (one of \"dataset\", \"model\", \"inbox\")"
},
"name": {
"type": "string",
"description": "Name of the file"
},
"contentLength": {
"type": "integer",
"description": "Content length of the file in bytes"
},
"contentType": {
"type": "string",
"description": "Content/MIME type (e.g. \"text/plain\") of the file"
},
"lastModifiedEpochSeconds": {
"type": "integer",
"description": "Last modified date of file in seconds since epoch in UTC"
}
}
},
"ApiBlobType": {
"type": "string",
"description": "To which entity this blob refers",
"enum": [
"dataset",
"model",
"inbox"
]
},
"StartBlobUploadResponse": {
"required": [
"createUrl",
"token"
],
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Opaque string token used to reference the new blob/file."
},
"createUrl": {
"type": "string",
"description": "URL to use to start the upload."
}
}
},
"CreateInboxFileRequest": {
"required": [
"blobFileToken",
"virtualDirectory"
],
"type": "object",
"properties": {
"virtualDirectory": {
"type": "string",
"description": "Directory name used for tagging the uploaded file"
},
"blobFileToken": {
"type": "string",
"description": "Token representing the uploaded file"
}
}
}
},
"parameters": {
"guidParam": {
"name": "guid",
"in": "path",
"description": "guid specifies location where submission should be uploaded",
"required": true,
"schema": {
"minimum": 0,
"type": "string"
}
}
},
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic"
}
}
},
"x-original-swagger-version": "2.0"
}