Create resources for a dataset according to the specified chain

POST 
/v1/project/:project_id/resources

Create a chain of resources for a dataset.

This endpoint allows you to specify a list of resources to create, with their dependencies. Resources will be created in the correct order based on their dependencies.

Request

Path Parameters

project_id Project Idrequired

application/json

Body

array

required

• Array [

anyOf

DATASET_CHECKPOINT_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

composite_filter

object

anyOf

columns

object

anyOf

MOD1

Array [

string

]

timestamp

object

anyOf

MOD1

integer

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

EMBEDDING_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

embedding_target

object

anyOf

MOD1

string

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

EMBEDDING_SET_INFERRED_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

source_column Source Column (string)required

The text column to generate embeddings from

embedding_model

object

required

Which text embedding model to use

anyOf

MOD1

string

MOD2

string

MOD3

string

MOD4

string

MOD5

string

MOD6

string

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

HNSW_INDEX_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

n_neighbors

Default value: 15

ef_construction

Default value: 64

M

Default value: 32

local_neighborhood_size

Default value: 32

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

EMBEDDING_DERIVED_2D_COORDINATE_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

dims integer[]

Default value: 0,1

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

RANDOM_COORDINATE_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

UMAP_COORDINATE_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

n_neighbors The number of neighbors to use for UMAP. (integer)

Default value: 15

min_dist How tightly UMAP should pack points together. (number)

Default value: 0.1

metric The metric to use for distance computation. (string)

Default value: euclidean

repulsion_strength Weighting applied to negative samples. Values higher than one will result in greater weight being given to negative samples. (number)

Default value: 1

negative_sample_rate Number of negative samples to use during training. (integer)

Default value: 5

n_epochs

object

anyOf

MOD1

integer

cluster_unique_points Whether to cluster unique points. (boolean)

Default value: true

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

TSNE_COORDINATE_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

perplexity Affects the tradeoff between global and local relationship presentation (integer)

Default value: 30

early_exaggeration

object

anyOf

MOD1

integer

MOD2

string

early_exaggeration_iter Number of iterations with early exaggeration (integer)

Default value: 250

n_iter Number of iterations (integer)

Default value: 500

exaggeration

object

anyOf

MOD1

integer

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

SVD_COORDINATE_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

n_components SVD's n_components (integer)

Default value: 2

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

PCA_COORDINATE_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

n_components PCA's n_components (integer)

Default value: 2

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

NPV1_COORDINATE_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

n_noise

object

anyOf

MOD1

integer

n_epochs Number of epochs (integer)

Default value: 50

spread

object

anyOf

MOD1

number

min_dist

object

anyOf

MOD1

number

n_init_epochs

object

anyOf

MOD1

integer

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

NPV2_COORDINATE_SET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

n_noise

object

anyOf

MOD1

integer

n_epochs Number of epochs (integer)

Default value: 50

spread

object

anyOf

MOD1

number

min_dist

object

anyOf

MOD1

number

n_init_epochs

object

anyOf

MOD1

integer

rho Controls local structure optimizing step for `nomic-project-v2`. Min value: `0`; max value: `1` (number)

Default value: 0.6

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

CLUSTER_ASSIGNMENT_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

cluster_method

object

anyOf

MOD1

string

enforce_hierarchy

object

anyOf

MOD1

boolean

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

HDBSCAN_CLUSTER_ASSIGNMENT_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

cluster_method

object

anyOf

MOD1

string

min_cluster_size Min Cluster Size (integer)

Default value: 15

min_samples Min Samples (integer)

Default value: 15

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

CHECKPOINT_DESCRIPTION_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

fields

object

anyOf

MOD1

Array [

string

]

maximum_characters The maximum number of characters to use for the description (integer)

Default value: 10000

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

QUADTREE_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

colorable_fields string[]

Default value: ``

The fields that can be colored by.

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

DUPLICATES_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

duplicate_cutoff Duplicate cut-off (number)

Default value: 0.1

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

KEYWORDS_TOPIC_LABEL_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

target_field Field to extract keywords from (string)required

jaccard_similarity_threshold Jaccard similarity threshold (number)

Default value: 0.62

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

LLM_TOPIC_LABEL_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

TOPIC_LABEL_POSITIONS_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

MAP_CHECKPOINT_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

map_id

object

anyOf

MOD1

string

email_type

object

anyOf

MOD1

string

Possible values: [Dataset ready, None]

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

SIDECAR_FROM_PARQUET_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

sidecar_name The sidecar name (string)required

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

EMBEDDING_SIDECAR_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

SIDECAR_FROM_DATA_TABLE_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

column_names string[]required

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

CLUSTER_SIDECAR_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

OPENGRAPH_IMAGE_REQUEST

resource_type Resource Type (string)required

The type of resource to create. e.g. 'EMBEDDING_SET'

dependencies

object

A mapping of resource types to the ids of the resources that must be created before this one. We will look in two different places for the string values here:

First, in the refs field of the passed list of resources. Finally, this will be treated as the UUID of a resource in the database.

property name*

object

anyOf

MOD1

string

MOD2

Array [

string

]

dataset_id Dataset Id (string)required

The id of the dataset to use for this resource.

color_column

object

anyOf

MOD1

string

map_id Map Id (string)required

ref Ref (string)required

An identifier to use for this resource in the context of building a set of jobs. This id WILL NOT BE used in the database or system.

• ]

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

type Type (string)required

Resource type.

id Id (string)required

The resource id.

dataset_id Dataset Id (string)required

The dataset id associated with the resource.

status ResourceStatus (string)required

Possible values: [COMPLETED, FAILED, BUILDING, WAITING]

The resource status.

params

object

required

Resource-specific parameters.

property name* any

Resource-specific parameters.

• ]

Example (from schema)

[
  {
    "type": "string",
    "id": "string",
    "dataset_id": "string",
    "status": "COMPLETED",
    "params": {}
  }
]

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...