Create Connector Dataset Handler

POST 
/v1/connector/:connector_id/dataset

Create a new dataset through a specific connector.

Request

Path Parameters

connector_id Connector Idrequired

application/json

Body

required

connector_name Connector Name (string)required

creation_params

object

required

property name* any

create_dataset_params

object

required

organization_id Organization Id (string)required

Unique organization id

project_name Project Name (string)required

The name of the project

modality

object

The data modality of this project. DEPRECATED.

anyOf

MOD1

string

unique_id_field

object

DEPRECATED: The unique ID field of the project.

anyOf

MOD1

string

description Description (string)

A description of your project.

is_public Is Public (boolean)

Is the project public?

is_public_to_org

object

Is the project public to the organization?

anyOf

MOD1

boolean

slug

object

The desired url slug for the project

anyOf

MOD1

string

privacy

object

The privacy of the project

anyOf

MOD1

string

Possible values: [public, with_link, private, restricted]

metadata

object

Metadata with which to initialize the connector

property name* any

Default value: [object Object]

Metadata with which to initialize the connector

Responses

201

Successful Response

application/json

Schema

Schema

created_dataset

object

required

project_id Project Id (string)required

The ID of the newly created project

slug Slug (string)required

The unique url slug of the project

creation_params

object

required

property name* any

metadata

object

required

property name* any

Example (from schema)

{
  "created_dataset": {
    "project_id": "string",
    "slug": "string"
  },
  "creation_params": {},
  "metadata": {}
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...