Skip to main content

Fetch Project

gethttps://api-atlas.nomic.ai/v1/dataset/{project_id}

⚠️ WARNING

This endpoint is unstable & not officially supported. It may be deprecated and removed in future API versions.

Fetch Project

Request​

project_idany | path*required

Responses​

200Successful Response
idstring*required

Project ID

ownerstring*required

The organization ID that owns this project

project_namestring*required

The name of this project

creatorstring

The user id who created this project.

descriptionstring*required

A description for this project.

is_publicboolean*required

Is the project viewable without being in the organzation?

is_public_to_orgboolean*required

Is the project viewable to the organization?

privacystring*required

The privacy settings for who can view the project.

Possible values: public, with_link, private, restricted

project_fieldsarray<string>*required

The list of fields a datum in the project may contain.

unique_id_fieldstring

DEPRECATED: A field that contains a unique id for each document.

modalitystring

The project modality. DEPRECATED.

total_datums_in_projectinteger*required

Total datums in project.

created_timestampstring ($date-time)*required

The timestamp this project was created.

slugstring*required

The project url-safe slug

connector_namestring

The connector name used to create this project

organization_slugstring*required

The organization url-safe slug

organization_namestring*required

The organization nickname

creator_nicknamestring

The creator nickname

creator_picturestring*required

The creator picture

og_imagestring*required

The datasets opengraph image

atlas_indicesarray<object>*required

All Atlas Indices built overtop of this project.

idstring*required

Index ID

project_idstring*required

The project this index belongs to

index_namestring*required

The name of the index

indexed_fieldstring*required

The field that was indexed in the datums.

created_timestampstring ($date-time)*required

The timestamp this index was created.

updated_timestampstring ($date-time)*required

The timestamp this indx was updated.

atomsarray<string>*required

All of the atoms in this index.

colorable_fieldsarray<string>*required

The fields that can be colored by.

embeddersarray<object>*required

The embedder this Atlas Index uses.

idstring*required

Embedder id ID

atlas_index_idstring*required

The index this atomizer corresponds to.

readyboolean*required

Is this embedder ready?

model_namestring*required

The embedder model this embedder embeds with.

hyperparametersobject*required

The hyperparameters this model was trained with.

nearest_neighbor_indicesarray<object>*required

The nearest neighbor index this Atlas Index uses.

idstring*required

Nearest Neighbor Index ID

index_namestring*required

The type of nearest neighbor index

readyboolean*required

Is this NN index ready?

hyperparametersobject*required

The hyperparameters of this index.

atom_strategiesarray<string>*required

The phrase strategies of the phrases this embedder is embedding.

projectionsarray<object>*required

The nearest neighbor index this Atlas Index uses.

idstring*required

Projection ID

projection_namestring*required

The type of projection

readyboolean*required

Is this projection ready?

hyperparametersobject*required

The hyperparameters of this projection.

atom_strategiesarray<string>*required

The phrase strategies of the phrases this embedder is embedding.

created_timestampstring ($date-time)*required

The timestamp this projection was created.

updated_timestampstring ($date-time)*required

The timestamp this projection was updated.

thumbnailstring

The thumbnail of this projection.

Default: ""

og_imagestring

The og image of this projection.

Default: ""

insert_update_delete_lockboolean*required

Whether the project is locked for CRUD operations.

access_rolestring*required

Access role of user for this project

Possible values: ADMIN, EDITOR, VIEWER, EXTERNAL, NONE

permissionsobject*required

Access role of user for this dataset

schemastring

An Arrow schema for the project. Binary data encoded as base64.

connector_detailsobject

The connector details for this project

idstring*required
creation_paramsobject*required
metadataobject*required
mapsarray<object>*required

The maps associated with this project

map_idstring

Map ID (or None for index-path maps)

projection_idstring*required

Projection ID

created_timestampstring ($date-time)*required

The timestamp this map was created.

modified_timestampstring ($date-time)*required

The timestamp this map was last modified.

readyboolean*required

Whether the map is ready to use.

errorstring

The error message if the map is permanently errored.

primary_projection_algorithmstring*required

The primary projection algorithm used for this map.

total_data_pointsinteger*required

The total number of data points in this map.

analyst_infoobject*required

The analyst info for this project

billed_organization_idstring

The billed organization id. None for anonymous users.

ai_subprocessorstring

The model to use for analysis

Possible values: openai, aws-bedrock

Default: "openai"

remaining_queriesinteger

The number of requests remaining for the month

Default: 0

422Validation Error

Examples​

curl
curl -X 'GET' \
  'https://api-atlas.nomic.ai/v1/dataset/{project_id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>'