Skip to main content

Fetch Project

GET 
/v1/project/:project_id

Fetches all details about a project.

Request​

Path Parameters

    project_id anyrequired

Responses​

Successful Response

Schema

    id Id (string)required

    Project ID

    owner Owner (string)required

    The organization ID that owns this project

    project_name Project Name (string)required

    The name of this project

    creator

    object

    The user id who created this project.

    anyOf

    string

    description Description (string)required

    A description for this project.

    is_public Is Public (boolean)required

    Is the project viewable without being in the organzation?

    is_public_to_org Is Public To Org (boolean)required

    Is the project viewable to the organization?

    privacy Privacy (string)required

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

    The privacy settings for who can view the project.

    project_fields string[]required

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

    unique_id_field

    object

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

    anyOf

    string

    modality

    object

    The project modality. DEPRECATED.

    anyOf

    string

    total_datums_in_project Total Datums In Project (integer)required

    Total datums in project.

    created_timestamp date-timerequired

    The timestamp this project was created.

    slug Slug (string)required

    The project url-safe slug

    connector_name

    object

    The connector name used to create this project

    anyOf

    string

    organization_slug Organization Slug (string)required

    The organization url-safe slug

    organization_name Organization Name (string)required

    The organization nickname

    creator_nickname

    object

    The creator nickname

    anyOf

    string

    creator_picture

    object

    required

    The creator picture

    anyOf

    string

    og_image

    object

    required

    The datasets opengraph image

    anyOf

    string

    atlas_indices

    object[]

    required

    All Atlas Indices built overtop of this project.

  • Array [

    • id Id (string)required

    Index ID

    project_id Project Id (string)required

    The project this index belongs to

    index_name Index Name (string)required

    The name of the index

    indexed_field

    object

    required

    The field that was indexed in the datums.

    anyOf

    string

    created_timestamp date-timerequired

    The timestamp this index was created.

    updated_timestamp date-timerequired

    The timestamp this indx was updated.

    atoms string[]required

    All of the atoms in this index.

    colorable_fields string[]required

    The fields that can be colored by.

    embedders

    object[]

    required

    The embedder this Atlas Index uses.

  • Array [

    • id Id (string)required

    Embedder id ID

    atlas_index_id Atlas Index Id (string)required

    The index this atomizer corresponds to.

    ready Ready (boolean)required

    Is this embedder ready?

    model_name Model Name (string)required

    The embedder model this embedder embeds with.

    hyperparameters

    object

    required

    The hyperparameters this model was trained with.

    property name* any

    The hyperparameters this model was trained with.

  • ]

    • nearest_neighbor_indices

    object[]

    required

    The nearest neighbor index this Atlas Index uses.

  • Array [

    • id Id (string)required

    Nearest Neighbor Index ID

    index_name Index Name (string)required

    The type of nearest neighbor index

    ready Ready (boolean)required

    Is this NN index ready?

    hyperparameters

    object

    required

    The hyperparameters of this index.

    property name* any

    The hyperparameters of this index.

    atom_strategies string[]required

    The phrase strategies of the phrases this embedder is embedding.

  • ]

    • projections

    object[]

    required

    The nearest neighbor index this Atlas Index uses.

  • Array [

    • id Id (string)required

    Projection ID

    projection_name Projection Name (string)required

    The type of projection

    ready Ready (boolean)required

    Is this projection ready?

    hyperparameters

    object

    required

    The hyperparameters of this projection.

    property name* any

    The hyperparameters of this projection.

    atom_strategies string[]required

    The phrase strategies of the phrases this embedder is embedding.

    created_timestamp date-timerequired

    The timestamp this projection was created.

    updated_timestamp date-timerequired

    The timestamp this projection was updated.

    thumbnail Thumbnail (string)

    The thumbnail of this projection.

    og_image Og Image (string)

    The og image of this projection.

  • ]

  • ]

    • insert_update_delete_lock Insert Update Delete Lock (boolean)required

    Whether the project is locked for CRUD operations.

    access_role DatasetRole (string)required

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

    Access role of user for this project

    permissions

    object

    required

    Access role of user for this dataset

    property name* boolean

    schema

    object

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

    anyOf

    string

    connector_details

    object

    The connector details for this project

    anyOf

    id Id (string)required

    creation_params

    object

    required

    property name* any

    metadata

    object

    required

    property name* any

    maps

    object[]

    required

    The maps associated with this project

  • Array [

    • map_id

    object

    Map ID (or None for index-path maps)

    anyOf

    string

    projection_id Projection Id (string)required

    Projection ID

    created_timestamp date-timerequired

    The timestamp this map was created.

    modified_timestamp date-timerequired

    The timestamp this map was last modified.

    ready Ready (boolean)required

    Whether the map is ready to use.

    error

    object

    The error message if the map is permanently errored.

    anyOf

    string

    primary_projection_algorithm Primary Projection Algorithm (string)required

    The primary projection algorithm used for this map.

    total_data_points

    object

    required

    The total number of data points in this map.

    anyOf

    integer

  • ]

    • analyst_info

    object

    required

    The analyst info for this project

    billed_organization_id

    object

    The billed organization id. None for anonymous users.

    anyOf

    string

    ai_subprocessor Ai Subprocessor (string)

    Possible values: [openai, aws-bedrock]

    Default value: openai

    The model to use for analysis

    remaining_queries Remaining Queries (integer)

    Default value: 0

    The number of requests remaining for the month

Loading...