/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { '/v1/health/': { /** * Health Check * @description Runs a health check on this instance of the API. */ get: operations['health_check_v1_health__get']; }; '/v1/organization/{organization_id_or_slug}': { /** * Fetch Organization * @description Fetches all details about an organization. * Presents limited amounts of information based on the user's affiliation with the organization. * Pagination with limit and offset parameters */ get: operations['fetch_organization_v1_organization__organization_id_or_slug__get']; }; '/v1/organization/{organization_id_or_slug}/usage2': { /** * Get Organization Usage Handler * @description Fetches the organization usage for the given period. */ get: operations['get_organization_usage_handler_v1_organization__organization_id_or_slug__usage2_get']; }; '/v1/organization/{organization_id_or_slug}/usage': { /** * Fetch Organization Usage * @description Computes the organization usage in the past 1 month. * * since_last_billing_date: If True and organization is on a paid tier, only returns usage after the last billing date. */ get: operations['fetch_organization_usage_v1_organization__organization_id_or_slug__usage_get']; }; '/v1/organization/search/{slug}': { /** * Fetch Organization Id By Slug * @description Returns the organization_id given a slug, even for private organizations. */ get: operations['fetch_organization_id_by_slug_v1_organization_search__slug__get']; }; '/v1/organization/rename': { /** * Update Organization Data * @description Changes the organization nickname given the organization ID */ post: operations['update_organization_data_v1_organization_rename_post']; }; '/v1/organization/update': { /** * Update Organization Data * @description Changes the organization nickname given the organization ID */ post: operations['update_organization_data_v1_organization_update_post']; }; '/v1/organization/create': { /** * Create Organization * @description Creates an organization on the free tier and sets the owner to the user sending the request. */ post: operations['create_organization_v1_organization_create_post']; }; '/v1/organization/search': { /** * Search User * @description Search user by nickname who is not already in organization */ post: operations['search_user_v1_organization_search_post']; }; '/v1/organization/members/add': { /** Add Organization Member */ post: operations['add_organization_member_v1_organization_members_add_post']; }; '/v1/organization/members/delete': { /** * Remove Organization Member * @description Removes a user from an organization. */ post: operations['remove_organization_member_v1_organization_members_delete_post']; }; '/v1/organization/members/remove': { /** * Remove Organization Member * @deprecated * @description Removes a user from an organization. */ post: operations['remove_organization_member_v1_organization_members_remove_post']; }; '/v1/organization/members/update': { /** * Modify Organization Member * @description Modifies a user in an organization */ post: operations['modify_organization_member_v1_organization_members_update_post']; }; '/v1/organization/members/modify': { /** * Modify Organization Member * @deprecated * @description Modifies a user in an organization */ post: operations['modify_organization_member_v1_organization_members_modify_post']; }; '/v1/organization/member/invite': { /** * Deprecated Invite Member In Organization * @deprecated * @description Invites a user in an organization */ post: operations['deprecated_invite_member_in_organization_v1_organization_member_invite_post']; }; '/v1/organization/members/invite': { /** * Invite Member In Organization * @description Invites a user in an organization */ post: operations['invite_member_in_organization_v1_organization_members_invite_post']; }; '/v1/organization/invitations': { /** * Get Organization Invitations * @description Get organization invitations for user */ post: operations['get_organization_invitations_v1_organization_invitations_post']; }; '/v1/organization/invitation/{invitation_id}/accept': { /** * Accept Organization Invitation * @description Accepts an invitation to join an organization */ post: operations['accept_organization_invitation_v1_organization_invitation__invitation_id__accept_post']; }; '/v1/organization/invitation/{invitation_id}/reject': { /** * Reject Organization Invitation * @description Rejects an invitation to join an organization */ post: operations['reject_organization_invitation_v1_organization_invitation__invitation_id__reject_post']; }; '/v1/organization/invitation/status': { /** * Update Invitation Status * @deprecated * @description Accept or reject invitation */ post: operations['update_invitation_status_v1_organization_invitation_status_post']; }; '/v1/organization/invitations/pending': { /** * Get Organization Pending Invitations * @description Get organization pending invitations */ post: operations['get_organization_pending_invitations_v1_organization_invitations_pending_post']; }; '/v1/organization/invitations/delete': { /** * Remove Pending Invitation * @description Delete pending invitation */ post: operations['remove_pending_invitation_v1_organization_invitations_delete_post']; }; '/v1/organization/{organization_id_or_slug}/access-requests': { /** * Get Organization Access Requests Handler * @description Get organization access requests */ get: operations['get_organization_access_requests_handler_v1_organization__organization_id_or_slug__access_requests_get']; }; '/v1/organization/access-requests': { /** * Create Organization Access Request Handler * @description Request access to organization */ post: operations['create_organization_access_request_handler_v1_organization_access_requests_post']; }; '/v1/organization/access-requests/accept': { /** * Accept Organization Access Request Handler * @description Approve a request to access an organization */ post: operations['accept_organization_access_request_handler_v1_organization_access_requests_accept_post']; }; '/v1/organization/access-requests/reject': { /** * Reject Organization Access Request Handler * @description Reject a request to access an organization */ post: operations['reject_organization_access_request_handler_v1_organization_access_requests_reject_post']; }; '/v1/organization/access-requests/cancel': { /** * Cancel Organization Access Request Handler * @description Cancel a request to access an organization */ post: operations['cancel_organization_access_request_handler_v1_organization_access_requests_cancel_post']; }; '/v1/user/': { /** Fetch Current User */ get: operations['fetch_current_user_v1_user__get']; }; '/v1/user/authorization/keys/{organization_id}/create': { /** Create Api Key */ post: operations['create_api_key_v1_user_authorization_keys__organization_id__create_post']; }; '/v1/user/authorization/keys/{organization_id}/delete': { /** Delete Api Key */ post: operations['delete_api_key_v1_user_authorization_keys__organization_id__delete_post']; }; '/v1/user/authorization/keys/{organization_id}': { /** Get Api Keys */ get: operations['get_api_keys_v1_user_authorization_keys__organization_id__get']; }; '/v1/user/token': { /** Auth0 Obtain Token From Code */ post: operations['auth0_obtain_token_from_code_v1_user_token_post']; }; '/v1/user/token/refresh/{refresh_token}': { /** Auth0 Obtain Token From Refresh */ get: operations['auth0_obtain_token_from_refresh_v1_user_token_refresh__refresh_token__get']; }; '/v1/user/authorize': { /** Auth0 Authorize Redirect */ get: operations['auth0_authorize_redirect_v1_user_authorize_get']; }; '/v1/user/logout': { /** Logout */ get: operations['logout_v1_user_logout_get']; }; '/v1/project/tags/{project_id}': { /** Get Tags For Project */ get: operations['get_tags_for_project_v1_project_tags__project_id__get']; /** Add Tag To Project */ post: operations['add_tag_to_project_v1_project_tags__project_id__post']; /** Delete Tag From Project */ delete: operations['delete_tag_from_project_v1_project_tags__project_id__delete']; }; '/v1/project/{project_id}': { /** * Fetch Project * @description Fetches all details about a project. */ get: operations['fetch_project_v1_project__project_id__get']; }; '/v1/project/sidebar/list': { /** * Fetch All Project * @deprecated * @description Fetches all project for authenticated user. */ get: operations['fetch_all_project_v1_project_sidebar_list_get']; }; '/v1/project/': { /** * Fetch All Project * @description Fetches all project for authenticated user. */ get: operations['fetch_all_project_v1_project__get']; }; '/v1/project/update': { /** * Update Project Metadata * @description Edit project metadata. */ post: operations['update_project_metadata_v1_project_update_post']; }; '/v1/project/update/{project_id}': { /** * Update Project Metadata * @description Edit project metadata. */ post: operations['update_project_metadata_v1_project_update__project_id__post']; }; '/v1/project/search/vector': { /** Search Semantic */ post: operations['search_semantic_v1_project_search_vector_post']; }; '/v1/project/search/id': { /** Search Semantic Id */ get: operations['search_semantic_id_v1_project_search_id_get']; }; '/v1/project/search/name': { /** Project Name Search */ post: operations['project_name_search_v1_project_search_name_post']; }; '/v1/project/create': { /** * Create New Project * @description Create a project associated with an organization. */ post: operations['create_new_project_v1_project_create_post']; }; '/v1/project/remove': { /** * Remove A Project * @description Remove a project associated with an organization. * Additionally, kick off background tasks to remove other projects that are not fully deleted. */ post: operations['remove_a_project_v1_project_remove_post']; }; '/v1/project/index/remove': { /** * Remove A Index * @description Remove an index */ post: operations['remove_a_index_v1_project_index_remove_post']; }; '/v1/project/update_indices': { /** * Update Project Indices * @deprecated * @description Updates the indices in a project that has unindexed progressively added data */ post: operations['update_project_indices_v1_project_update_indices_post']; }; '/v1/project/data/delete': { /** * Data Delete * @description Deletes datums and corresponding atoms from the project. Does not reflect in project/index state until an * index update call if made (transaction commit) */ post: operations['data_delete_v1_project_data_delete_post']; }; '/v1/project/data/update': { /** * Data Update * @description Updates the requested datums. Does not reflect in project/index state until an * index update call if made (transaction commit) */ post: operations['data_update_v1_project_data_update_post']; }; '/v1/project/data/get/arrow': { /** * Data Get Arrow * @description Export data as arrow format for a project and/or index */ post: operations['data_get_arrow_v1_project_data_get_arrow_post']; }; '/v1/project/data/add/arrow': { /** * Add Arrow * @description Add data to a project in arrow format. */ post: operations['add_arrow_v1_project_data_add_arrow_post']; }; '/v1/project/data/add/blobs': { /** * Add Blob * @description Add blob to S3 for usage within a map */ post: operations['add_blob_v1_project_data_add_blobs_post']; }; '/v1/project/data/get/blob/{dataset_id}/{blob_hash}': { /** Data Get Blob */ get: operations['data_get_blob_v1_project_data_get_blob__dataset_id___blob_hash__get']; }; '/v1/project/data/get/nearest_neighbors/by_embedding': { /** Nearest Neighbors By Embedding */ post: operations['nearest_neighbors_by_embedding_v1_project_data_get_nearest_neighbors_by_embedding_post']; }; '/v1/project/data/get/arrow/nearest_neighbors/by_id': { /** Nearest Neighbors By Ids Arrow */ post: operations['nearest_neighbors_by_ids_arrow_v1_project_data_get_arrow_nearest_neighbors_by_id_post']; }; '/v1/project/data/get/nearest_neighbors/by_id': { /** Nearest Neighbors By Ids */ post: operations['nearest_neighbors_by_ids_v1_project_data_get_nearest_neighbors_by_id_post']; }; '/v1/project/data/get/embedding/topic': { /** Data Topic Query */ post: operations['data_topic_query_v1_project_data_get_embedding_topic_post']; }; '/v1/project/data/get/embedding/paged': { /** * Get Embedding Page Endpoint * @description Get a page of embedding data for a project */ post: operations['get_embedding_page_endpoint_v1_project_data_get_embedding_paged_post']; }; '/v1/project/projection/{map_id}/datums': { /** * Datum Table * @description Get a table of datums for a map */ get: operations['datum_table_v1_project_projection__map_id__datums_get']; }; '/v1/project/data/get': { /** Get Datums By Ids Handler */ post: operations['get_datums_by_ids_handler_v1_project_data_get_post']; }; '/v1/project/atoms/get': { /** Atoms Get */ post: operations['atoms_get_v1_project_atoms_get_post']; }; '/v1/project/index/create': { /** * Create Index * @description Creates an index and returns the job id of the index creation job. */ post: operations['create_index_v1_project_index_create_post']; }; '/v1/project/index/job/{job_id}': { /** * Fetch Index Job * @description Fetches an index job to the front-end. */ get: operations['fetch_index_job_v1_project_index_job__job_id__get']; }; '/v1/project/index/job/progress/{index_id}': { /** * Fetch Job Progress * @description Fetches latest job data by index id. */ get: operations['fetch_job_progress_v1_project_index_job_progress__index_id__get']; }; '/v1/project/jobs/status/{index_id}': { /** * Fetch Job System State * @description Gets the state of the job system for a particular atlas index. */ get: operations['fetch_job_system_state_v1_project_jobs_status__index_id__get']; }; '/v1/project/{project_id}/index/projection/{projection_id}/quadtree/manifest.feather': { /** Quadtree Manifest */ get: operations['quadtree_manifest_v1_project__project_id__index_projection__projection_id__quadtree_manifest_feather_get']; }; '/v1/project/{project_id}/index/projection/{projection_id}/quadtree/{quadtree_key}': { /** * Fetch Quadtree Tile * @description Fetches a quadtree tile to the front-end. */ get: operations['fetch_quadtree_tile_v1_project__project_id__index_projection__projection_id__quadtree__quadtree_key__get']; /** Fetch Quadtree Tile With Payload */ post: operations['fetch_quadtree_tile_with_payload_v1_project__project_id__index_projection__projection_id__quadtree__quadtree_key__post']; }; '/v1/project/projection/{projection_id}/schema': { /** Fetch Schema */ get: operations['fetch_schema_v1_project_projection__projection_id__schema_get']; }; '/v1/project/{atlas_index_id}/topic_density': { /** Topic Density */ post: operations['topic_density_v1_project__atlas_index_id__topic_density_post']; }; '/v1/project/{project_id}/index/projection/{projection_id}': { /** * Fetch Map Information * @description Fetches all information about a map such as topics, defaults, etc. */ get: operations['fetch_map_information_v1_project__project_id__index_projection__projection_id__get']; }; '/v1/project/projection/alias/{projection_alias}': { /** * Fetch Projection Alias * @description Fetches project id and projection id from an alias. */ get: operations['fetch_projection_alias_v1_project_projection_alias__projection_alias__get']; }; '/v1/project/projection/alias/edit/{project_id}': { /** * Update Projection Alias * @description Edit or add projection alias. */ post: operations['update_projection_alias_v1_project_projection_alias_edit__project_id__post']; }; '/v1/project/projection/alias/get/{project_id}': { /** * Fetch Projection Alias By Projection Id * @description Get projection alias by projection id. */ post: operations['fetch_projection_alias_by_projection_id_v1_project_projection_alias_get__project_id__post']; }; '/v1/project/topics/update/{topic_model_id}': { /** * Update Topic Model * @description Updates a topic model geojson with updates to topic position or topic label. * Currently accomplishes this by accepting an entirely new geojson and replacing * existing one. Will eventually be more granular than that. */ post: operations['update_topic_model_v1_project_topics_update__topic_model_id__post']; }; '/v1/project/search/user': { /** * Search User * @description Searches against users by nickname and email who are non in the organization of the user performing search. * This endpoint is used when attempting to invite users to an organization. */ post: operations['search_user_v1_project_search_user_post']; }; '/v1/project/{organization_slug}/project/{project_slug}': { /** * Fetch Project By Slug * @description Fetches all details about a project. */ get: operations['fetch_project_by_slug_v1_project__organization_slug__project__project_slug__get']; }; '/v1/project/{organization_slug}/{project_slug}': { /** * Fetch Project By Slug * @description Fetches all details about a project. */ get: operations['fetch_project_by_slug_v1_project__organization_slug___project_slug__get']; }; '/v1/project/projection/{projection_id}/view/{state_hash}': { /** * Fetch Projection View From Hash * @description Fetches state-view variables for a projection. */ get: operations['fetch_projection_view_from_hash_v1_project_projection__projection_id__view__state_hash__get']; }; '/v1/project/projection/{projection_id}/view': { /** * Create Hash * @description sets a projection state on a project */ post: operations['create_hash_v1_project_projection__projection_id__view_post']; }; '/v1/project/projection/{map_id}/get/dataset_id': { /** Get Project Id From Map Id */ get: operations['get_project_id_from_map_id_v1_project_projection__map_id__get_dataset_id_get']; }; '/v1/project/{dataset_id}/members/': { /** * Get Dataset Members * @description Fetches all dataset members */ get: operations['get_dataset_members_v1_project__dataset_id__members__get']; }; '/v1/project/{dataset_id}/members/add': { /** Add Dataset Member */ post: operations['add_dataset_member_v1_project__dataset_id__members_add_post']; }; '/v1/project/{dataset_id}/members/delete': { /** * Remove Dataset Member * @description Remove a dataset member */ post: operations['remove_dataset_member_v1_project__dataset_id__members_delete_post']; }; '/v1/project/{dataset_id}/members/update': { /** * Update Dataset Member * @description Update a dataset member role */ post: operations['update_dataset_member_v1_project__dataset_id__members_update_post']; }; '/v1/dataset/tags/{project_id}': { /** Get Tags For Project */ get: operations['get_tags_for_project_v1_dataset_tags__project_id__get']; /** Add Tag To Project */ post: operations['add_tag_to_project_v1_dataset_tags__project_id__post']; /** Delete Tag From Project */ delete: operations['delete_tag_from_project_v1_dataset_tags__project_id__delete']; }; '/v1/dataset/{project_id}': { /** * Fetch Project * @description Fetches all details about a project. */ get: operations['fetch_project_v1_dataset__project_id__get']; }; '/v1/dataset/sidebar/list': { /** * Fetch All Project * @deprecated * @description Fetches all project for authenticated user. */ get: operations['fetch_all_project_v1_dataset_sidebar_list_get']; }; '/v1/dataset/': { /** * Fetch All Project * @description Fetches all project for authenticated user. */ get: operations['fetch_all_project_v1_dataset__get']; }; '/v1/dataset/update': { /** * Update Project Metadata * @description Edit project metadata. */ post: operations['update_project_metadata_v1_dataset_update_post']; }; '/v1/dataset/update/{project_id}': { /** * Update Project Metadata * @description Edit project metadata. */ post: operations['update_project_metadata_v1_dataset_update__project_id__post']; }; '/v1/dataset/search/vector': { /** Search Semantic */ post: operations['search_semantic_v1_dataset_search_vector_post']; }; '/v1/dataset/search/id': { /** Search Semantic Id */ get: operations['search_semantic_id_v1_dataset_search_id_get']; }; '/v1/dataset/search/name': { /** Project Name Search */ post: operations['project_name_search_v1_dataset_search_name_post']; }; '/v1/dataset/create': { /** * Create New Project * @description Create a project associated with an organization. */ post: operations['create_new_project_v1_dataset_create_post']; }; '/v1/dataset/remove': { /** * Remove A Project * @description Remove a project associated with an organization. * Additionally, kick off background tasks to remove other projects that are not fully deleted. */ post: operations['remove_a_project_v1_dataset_remove_post']; }; '/v1/dataset/index/remove': { /** * Remove A Index * @description Remove an index */ post: operations['remove_a_index_v1_dataset_index_remove_post']; }; '/v1/dataset/update_indices': { /** * Update Project Indices * @deprecated * @description Updates the indices in a project that has unindexed progressively added data */ post: operations['update_project_indices_v1_dataset_update_indices_post']; }; '/v1/dataset/data/delete': { /** * Data Delete * @description Deletes datums and corresponding atoms from the project. Does not reflect in project/index state until an * index update call if made (transaction commit) */ post: operations['data_delete_v1_dataset_data_delete_post']; }; '/v1/dataset/data/update': { /** * Data Update * @description Updates the requested datums. Does not reflect in project/index state until an * index update call if made (transaction commit) */ post: operations['data_update_v1_dataset_data_update_post']; }; '/v1/dataset/data/get/arrow': { /** * Data Get Arrow * @description Export data as arrow format for a project and/or index */ post: operations['data_get_arrow_v1_dataset_data_get_arrow_post']; }; '/v1/dataset/data/add/arrow': { /** * Add Arrow * @description Add data to a project in arrow format. */ post: operations['add_arrow_v1_dataset_data_add_arrow_post']; }; '/v1/dataset/data/add/blobs': { /** * Add Blob * @description Add blob to S3 for usage within a map */ post: operations['add_blob_v1_dataset_data_add_blobs_post']; }; '/v1/dataset/data/get/blob/{dataset_id}/{blob_hash}': { /** Data Get Blob */ get: operations['data_get_blob_v1_dataset_data_get_blob__dataset_id___blob_hash__get']; }; '/v1/dataset/data/get/nearest_neighbors/by_embedding': { /** Nearest Neighbors By Embedding */ post: operations['nearest_neighbors_by_embedding_v1_dataset_data_get_nearest_neighbors_by_embedding_post']; }; '/v1/dataset/data/get/arrow/nearest_neighbors/by_id': { /** Nearest Neighbors By Ids Arrow */ post: operations['nearest_neighbors_by_ids_arrow_v1_dataset_data_get_arrow_nearest_neighbors_by_id_post']; }; '/v1/dataset/data/get/nearest_neighbors/by_id': { /** Nearest Neighbors By Ids */ post: operations['nearest_neighbors_by_ids_v1_dataset_data_get_nearest_neighbors_by_id_post']; }; '/v1/dataset/data/get/embedding/topic': { /** Data Topic Query */ post: operations['data_topic_query_v1_dataset_data_get_embedding_topic_post']; }; '/v1/dataset/data/get/embedding/paged': { /** * Get Embedding Page Endpoint * @description Get a page of embedding data for a project */ post: operations['get_embedding_page_endpoint_v1_dataset_data_get_embedding_paged_post']; }; '/v1/dataset/projection/{map_id}/datums': { /** * Datum Table * @description Get a table of datums for a map */ get: operations['datum_table_v1_dataset_projection__map_id__datums_get']; }; '/v1/dataset/data/get': { /** Get Datums By Ids Handler */ post: operations['get_datums_by_ids_handler_v1_dataset_data_get_post']; }; '/v1/dataset/atoms/get': { /** Atoms Get */ post: operations['atoms_get_v1_dataset_atoms_get_post']; }; '/v1/dataset/index/create': { /** * Create Index * @description Creates an index and returns the job id of the index creation job. */ post: operations['create_index_v1_dataset_index_create_post']; }; '/v1/dataset/index/job/{job_id}': { /** * Fetch Index Job * @description Fetches an index job to the front-end. */ get: operations['fetch_index_job_v1_dataset_index_job__job_id__get']; }; '/v1/dataset/index/job/progress/{index_id}': { /** * Fetch Job Progress * @description Fetches latest job data by index id. */ get: operations['fetch_job_progress_v1_dataset_index_job_progress__index_id__get']; }; '/v1/dataset/jobs/status/{index_id}': { /** * Fetch Job System State * @description Gets the state of the job system for a particular atlas index. */ get: operations['fetch_job_system_state_v1_dataset_jobs_status__index_id__get']; }; '/v1/dataset/{project_id}/index/projection/{projection_id}/quadtree/manifest.feather': { /** Quadtree Manifest */ get: operations['quadtree_manifest_v1_dataset__project_id__index_projection__projection_id__quadtree_manifest_feather_get']; }; '/v1/dataset/{project_id}/index/projection/{projection_id}/quadtree/{quadtree_key}': { /** * Fetch Quadtree Tile * @description Fetches a quadtree tile to the front-end. */ get: operations['fetch_quadtree_tile_v1_dataset__project_id__index_projection__projection_id__quadtree__quadtree_key__get']; /** Fetch Quadtree Tile With Payload */ post: operations['fetch_quadtree_tile_with_payload_v1_dataset__project_id__index_projection__projection_id__quadtree__quadtree_key__post']; }; '/v1/dataset/projection/{projection_id}/schema': { /** Fetch Schema */ get: operations['fetch_schema_v1_dataset_projection__projection_id__schema_get']; }; '/v1/dataset/{atlas_index_id}/topic_density': { /** Topic Density */ post: operations['topic_density_v1_dataset__atlas_index_id__topic_density_post']; }; '/v1/dataset/{project_id}/index/projection/{projection_id}': { /** * Fetch Map Information * @description Fetches all information about a map such as topics, defaults, etc. */ get: operations['fetch_map_information_v1_dataset__project_id__index_projection__projection_id__get']; }; '/v1/dataset/projection/alias/{projection_alias}': { /** * Fetch Projection Alias * @description Fetches project id and projection id from an alias. */ get: operations['fetch_projection_alias_v1_dataset_projection_alias__projection_alias__get']; }; '/v1/dataset/projection/alias/edit/{project_id}': { /** * Update Projection Alias * @description Edit or add projection alias. */ post: operations['update_projection_alias_v1_dataset_projection_alias_edit__project_id__post']; }; '/v1/dataset/projection/alias/get/{project_id}': { /** * Fetch Projection Alias By Projection Id * @description Get projection alias by projection id. */ post: operations['fetch_projection_alias_by_projection_id_v1_dataset_projection_alias_get__project_id__post']; }; '/v1/dataset/topics/update/{topic_model_id}': { /** * Update Topic Model * @description Updates a topic model geojson with updates to topic position or topic label. * Currently accomplishes this by accepting an entirely new geojson and replacing * existing one. Will eventually be more granular than that. */ post: operations['update_topic_model_v1_dataset_topics_update__topic_model_id__post']; }; '/v1/dataset/search/user': { /** * Search User * @description Searches against users by nickname and email who are non in the organization of the user performing search. * This endpoint is used when attempting to invite users to an organization. */ post: operations['search_user_v1_dataset_search_user_post']; }; '/v1/dataset/{organization_slug}/project/{project_slug}': { /** * Fetch Project By Slug * @description Fetches all details about a project. */ get: operations['fetch_project_by_slug_v1_dataset__organization_slug__project__project_slug__get']; }; '/v1/dataset/{organization_slug}/{project_slug}': { /** * Fetch Project By Slug * @description Fetches all details about a project. */ get: operations['fetch_project_by_slug_v1_dataset__organization_slug___project_slug__get']; }; '/v1/dataset/projection/{projection_id}/view/{state_hash}': { /** * Fetch Projection View From Hash * @description Fetches state-view variables for a projection. */ get: operations['fetch_projection_view_from_hash_v1_dataset_projection__projection_id__view__state_hash__get']; }; '/v1/dataset/projection/{projection_id}/view': { /** * Create Hash * @description sets a projection state on a project */ post: operations['create_hash_v1_dataset_projection__projection_id__view_post']; }; '/v1/dataset/projection/{map_id}/get/dataset_id': { /** Get Project Id From Map Id */ get: operations['get_project_id_from_map_id_v1_dataset_projection__map_id__get_dataset_id_get']; }; '/v1/dataset/{dataset_id}/members/': { /** * Get Dataset Members * @description Fetches all dataset members */ get: operations['get_dataset_members_v1_dataset__dataset_id__members__get']; }; '/v1/dataset/{dataset_id}/members/add': { /** Add Dataset Member */ post: operations['add_dataset_member_v1_dataset__dataset_id__members_add_post']; }; '/v1/dataset/{dataset_id}/members/delete': { /** * Remove Dataset Member * @description Remove a dataset member */ post: operations['remove_dataset_member_v1_dataset__dataset_id__members_delete_post']; }; '/v1/dataset/{dataset_id}/members/update': { /** * Update Dataset Member * @description Update a dataset member role */ post: operations['update_dataset_member_v1_dataset__dataset_id__members_update_post']; }; '/v1/stripe/promo-code/validate': { /** * Validate Promo Code * @description Validate a promo code against a plan type using Stripe API */ post: operations['validate_promo_code_v1_stripe_promo_code_validate_post']; }; '/v1/stripe/subscribe': { /** * Stripe Subscription * @description Create stripe subscription checkout session url and send it to front end */ post: operations['stripe_subscription_v1_stripe_subscribe_post']; }; '/v1/stripe/set_organization_limits': { /** * Set Organization Billing Limits * @description Sets the organization billing limits */ post: operations['set_organization_billing_limits_v1_stripe_set_organization_limits_post']; }; '/v1/stripe/cancel': { /** * Cancel Stripe Subscription * @description Create stripe subscription checkout session url and send it to front end */ post: operations['cancel_stripe_subscription_v1_stripe_cancel_post']; }; '/v1/stripe/webhook': { /** * Webhook Received * @description Monitor stripe webhook triggered events */ post: operations['webhook_received_v1_stripe_webhook_post']; }; '/v1/embedding/text': { /** * Embed Text * @description Generates text embeddings */ post: operations['embed_text_v1_embedding_text_post']; }; '/v1/project/projection/tags/create': { /** Create Tag Request */ post: operations['create_tag_request_v1_project_projection_tags_create_post']; }; '/v1/project/projection/tags/update/mask': { /** Tag Mask Request */ post: operations['tag_mask_request_v1_project_projection_tags_update_mask_post']; }; '/v1/project/projection/tags/delete': { /** Delete Tag Request */ post: operations['delete_tag_request_v1_project_projection_tags_delete_post']; }; '/v1/project/projection/tags/update': { /** Update Tag Request */ post: operations['update_tag_request_v1_project_projection_tags_update_post']; }; '/v1/project/projection/tags/get': { /** Get Tag Request */ get: operations['get_tag_request_v1_project_projection_tags_get_get']; }; '/v1/project/projection/tags/get/all': { /** Get Tags In Projection Request */ get: operations['get_tags_in_projection_request_v1_project_projection_tags_get_all_get']; }; '/v1/project/projection/tags/status': { /** Get Tag Status */ get: operations['get_tag_status_v1_project_projection_tags_status_get']; }; '/v1/project/projection/tags/robotag': { /** Tag Projection Job Request */ post: operations['tag_projection_job_request_v1_project_projection_tags_robotag_post']; }; '/v1/reduce/': { /** Reduce Dimensionality By Embedding */ post: operations['reduce_dimensionality_by_embedding_v1_reduce__post']; }; '/v1/search/datasets': { /** * Fetch Datasets By Query * @description Fetches datasets based on query parameters */ get: operations['fetch_datasets_by_query_v1_search_datasets_get']; }; } export type webhooks = Record; export interface components { schemas: { /** APIKeyCreationRequest */ APIKeyCreationRequest: { /** * Key Name * @description The name of the key to create. */ key_name: string; }; /** APIKeyCreationResponse */ APIKeyCreationResponse: { /** * Key * @description The API key that was created */ key: string; }; /** APIKeyDeletionRequest */ APIKeyDeletionRequest: { /** * Key Name * @description The name of the key to deleted. */ key_name: string; /** * User Id * @description User id * @example auth0|12345678 */ user_id?: string; }; /** APIKeyListItem */ APIKeyListItem: { /** Key Name */ key_name: string; /** * Expiration * Format: date-time */ expiration: string; /** * Creation * Format: date-time */ creation: string; /** Suffix */ suffix: string; /** User Id */ user_id: string; }; /** APIKeyListResponse */ APIKeyListResponse: { /** * Keys * @default [] */ keys?: components['schemas']['APIKeyListItem'][]; }; /** * AccessRole * @description An enumeration. * @enum {string} */ AccessRole: 'OWNER' | 'ADMIN' | 'MEMBER' | 'VIEWER' | 'EXTERNAL' | 'GUEST' | 'NONE'; /** AddBlobResponse */ AddBlobResponse: { /** * Hashes * @description The hashes of the blobs */ hashes: string[]; }; /** AddUserRequest */ AddUserRequest: { /** * User Id * @description Unique user id * @example auth0|12345678 */ user_id?: string; /** * Email * @description The email address associated with an Atlas account * @example jane@doe.com */ email?: string; /** * @description The access role the new user should have: MEMBER, ADMIN, OWNER * @example MEMBER */ access_role: components['schemas']['AccessRole']; /** * Organization Id * Format: uuid * @description Unique organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** AtlasIndex */ AtlasIndex: { /** * Id * Format: uuid * @description Index ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Project Id * Format: uuid * @description The project this index belongs to * @example 43adcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; /** * Index Name * @description The name of the index * @example My Test Index */ index_name: string; /** * Indexed Field * @description The field that was indexed in the datums. */ indexed_field: string; /** * Created Timestamp * Format: date-time * @description The timestamp this index was created. */ created_timestamp: string; /** * Updated Timestamp * Format: date-time * @description The timestamp this indx was updated. */ updated_timestamp: string; /** * Atoms * @description All of the atoms in this index. */ atoms: string[]; /** * Colorable Fields * @description The fields that can be colored by. */ colorable_fields: string[]; /** * Embedders * @description The embedder this Atlas Index uses. */ embedders: components['schemas']['Embedder'][]; /** * Nearest Neighbor Indices * @description The nearest neighbor index this Atlas Index uses. */ nearest_neighbor_indices: components['schemas']['NearestNeighborIndex'][]; /** * Projections * @description The nearest neighbor index this Atlas Index uses. */ projections: components['schemas']['Projection'][]; }; /** AtlasUsageResponse */ AtlasUsageResponse: { /** * Usage Since Date * Format: date-time * @description The start date this usage record represents */ usage_since_date: string; /** * Public Datapoints * @description The number of public datapoints used. */ public_datapoints: number; /** * Private Datapoints * @description The number of private datapoints used. */ private_datapoints: number; /** * Organization Seats * @description The number of organization seats currently used. */ organization_seats: number; /** Embedding Models */ embedding_models: components['schemas']['EmbeddingModelInferenceUsage'][]; }; /** AtomsRequest */ AtomsRequest: { /** * Project Id * Format: uuid * @description Unique project id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; /** * Index Id * Format: uuid * @description Unique index id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ index_id: string; /** * Atom Ids * @description List of strings corresponding to ids of atoms to get */ atom_ids: string[]; }; /** AtomsResponse */ AtomsResponse: { /** * Atoms * @description The data for each atom, keyed by its atom_id */ atoms: Record; }; /** BaseModel */ BaseModel: Record; /** Body_add_blob_v1_dataset_data_add_blobs_post */ Body_add_blob_v1_dataset_data_add_blobs_post: { /** * Dataset Id * @description The ID of the project. */ dataset_id: string; /** * Content Type * @description The content types of the blobs. */ content_type?: unknown[] | string; /** Urls */ urls?: string[]; /** * Blobs * @description A batch of blobs you want to upload to Atlas */ blobs?: string[]; }; /** Body_add_blob_v1_project_data_add_blobs_post */ Body_add_blob_v1_project_data_add_blobs_post: { /** * Dataset Id * @description The ID of the project. */ dataset_id: string; /** * Content Type * @description The content types of the blobs. */ content_type?: unknown[] | string; /** Urls */ urls?: string[]; /** * Blobs * @description A batch of blobs you want to upload to Atlas */ blobs?: string[]; }; /** CreateAtlasIndexRequest */ CreateAtlasIndexRequest: { /** * Project Id * Format: uuid * @description Unique project id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; /** * Index Name * @description The name of the index you are building. */ index_name?: string; /** * Colorable Fields * @description The fields that can be colored by. * @default [] */ colorable_fields?: string[]; /** * Modality * @description The data modality of the index. */ modality?: string; /** * Reuse Atoms And Embeddings From * @description If passed, will reuse atoms and embeddings from the specified index */ reuse_atoms_and_embeddings_from?: string; /** * Indexed Field * @description The field this index is indexing. Should be set to None for embedding projects. */ indexed_field: string; /** * Atomizer Strategies * @description The atomizer strategies to use when building this index. Should be set to None for embedding projects. * @default [ * "document" * ] */ atomizer_strategies?: string[]; /** * Geometry Strategies * @description The sets of geometry strategies to use when building this index. Should be set to None for embedding projects. * @default [ * [ * "document" * ] * ] */ geometry_strategies?: string[][]; /** * Model * @description The model to encode your data with. Should be set to None for embedding projects. */ model: string; /** * Model Hyperparameters * @description JSON representation of hyperparameters to train the model with. Should be set to None for embedding projects. */ model_hyperparameters: string; /** * Nearest Neighbor Index * @description The nearest neighbor index to build. */ nearest_neighbor_index: string; /** * Nearest Neighbor Index Hyperparameters * @description JSON representation of hyperparameters to train the model with */ nearest_neighbor_index_hyperparameters: string; /** * Projection * @description The projection to build. */ projection: string; /** * Projection Hyperparameters * @description JSON representation of hyperparameters to train the model with */ projection_hyperparameters: string; /** * Topic Model Hyperparameters * @description JSON representation of hyperparameters to build the topic model with * @default {"build_topic_model": false} */ topic_model_hyperparameters?: string; /** * Duplicate Detection Hyperparameters * @description JSON representation of hyperparameters used for duplicate detection * @default {"tag_duplicates": false, "duplicate_cutoff": 0.1} */ duplicate_detection_hyperparameters?: string; }; /** CreateAtlasIndexResponse */ CreateAtlasIndexResponse: { /** * Job Id * Format: uuid * @description The job id of the index creation job. */ job_id: string; }; /** CreateOrganizationRequest */ CreateOrganizationRequest: { /** * Nickname * @description The name of the organization. */ nickname: string; /** * Description * @description A description of the organization. */ description?: string; /** * Logo Url * @description The logo of the organization. */ logo_url?: string; /** * Website * @description The website of the organization. */ website?: string; /** * Organization Type * @description The type of organization. * @default personal */ organization_type?: string; }; /** CreateOrganizationResponse */ CreateOrganizationResponse: { /** * Organization Id * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** CreateProjectRequest */ CreateProjectRequest: { /** * Organization Id * Format: uuid * @description Unique organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * Project Name * @description The name of the project * @example example-project */ project_name: string; /** * Modality * @description The data modality of this project */ modality?: string; /** * Unique Id Field * @description The unique ID field of the project. */ unique_id_field: string; /** * Description * @description A description of your project. * @default */ description?: string; /** * Is Public * @description Is the project public? * @default false */ is_public?: boolean; /** * Slug * @description The desired url slug for the project */ slug?: string; }; /** CreateProjectionViewRequest */ CreateProjectionViewRequest: { /** * Dsl Rule * @description The JSON serialization of the selection state */ dsl_rule?: string; /** * Deepscatter Api * @description The JSON serialization of the deepscatter API call */ deepscatter_api?: string; }; /** DatasetMemberCreateRequest */ DatasetMemberCreateRequest: { /** * User ID * @description The user ID to add to the dataset */ user_id?: string; /** * User e-mail * @description The user Email to add to the dataset, if user_id is not available */ email?: string; /** * Dataset Role * @description The role to assign to the user in the dataset */ access_role: components['schemas']['DatasetRole']; }; /** DatasetMemberDeleteRequest */ DatasetMemberDeleteRequest: { /** * User ID * @description The user ID to remove from the dataset */ user_id: string; }; /** DatasetMemberUpdateRequest */ DatasetMemberUpdateRequest: { /** * User ID * @description The user ID to add to the dataset */ user_id?: string; /** * User e-mail * @description The user Email to add to the dataset, if user_id is not available */ email?: string; /** * Dataset Role * @description The role to assign to the user in the dataset */ access_role: components['schemas']['DatasetRole']; }; /** DatasetMembershipWithPicture */ DatasetMembershipWithPicture: { /** * Dataset Id * Format: uuid * @description Dataset ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ dataset_id: string; /** * Organization Id * Format: uuid * @description Organization ID */ organization_id: string; /** * Nickname * @description User nickname */ nickname: string; /** * User Id * @description User ID */ user_id: string; /** @description User access role in dataset, whether granted explicitly or from organization membership */ dataset_role: components['schemas']['DatasetRole']; /** @description Access role manually granted or based on dataset creation */ explicit_dataset_role?: components['schemas']['DatasetRole']; /** * Picture * @description The user's profile image */ picture?: string; /** Permissions */ permissions: { [key: string]: boolean; }; /** * Org Role * @description User access role in organization * @example member */ org_role: string; /** * Email * @description The user email */ email: string; }; /** * DatasetRole * @description An enumeration. * @enum {string} */ DatasetRole: 'ADMIN' | 'EDITOR' | 'VIEWER' | 'NONE'; /** DatasetSearchResult */ DatasetSearchResult: { /** * Project Id * Format: uuid * @description Project ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; /** * Project Name * @description The name of this project * @example example_project */ project_name: string; /** * Description * @description A description for this project. */ description: string; /** * Total Datums In Project * @description Total datums in project. */ total_datums_in_project: number; /** * Created Timestamp * Format: date-time * @description The timestamp this project was created. */ created_timestamp: string; /** * Nickname * @description The nickname who created this project. */ nickname: string; /** * Thumbnail * @description The project display thumbnail. */ thumbnail: string; /** * Slug * @description The project url-safe slug */ slug: string; /** * Organization Slug * @description The organization url-safe slug */ organization_slug: string; /** * Organization Name * @description The organization nickname */ organization_name: string; /** * Creator Picture * @description The creator picture */ creator_picture?: string; /** * Projection Alias * @description The projection alias */ projection_alias?: string; /** * Tags * @description Tags associated with the project from dataset_tags table. */ tags: string[]; /** * Index Job End Timestamp * Format: date-time * @description The timestamp the map index job finished. */ index_job_end_timestamp: string; }; /** DeletePendingInvitationRequest */ DeletePendingInvitationRequest: { /** * Id * Format: uuid * @description Initation id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Organization Id * Format: uuid * @description Inviter organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** DeprecatedInviteUserRequest */ DeprecatedInviteUserRequest: { /** * User Id * @description User id to invite * @example auth0|12345678 */ user_id: string; /** * Access Role * @description Role to set * @example MEMBER */ access_role: string; /** * Organization Id * Format: uuid * @description Inviter organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** DimensionalityReductionRequest */ DimensionalityReductionRequest: { /** * Embeddings * @description The embeddings you want to project. */ embeddings: number[][]; /** * N Neighbors * @description Number of neighbors for projection */ n_neighbors: number; /** * @description The model to use when projecting. * @default nomic-project-v1 */ model?: components['schemas']['NomicProjectModel']; }; /** DimensionalityReductionResponse */ DimensionalityReductionResponse: { /** * Projection * @description Projection of embeddings */ projection: number[][]; }; /** EditProjectRequest */ EditProjectRequest: { /** * Id * Format: uuid * @description The project id * @example df4dcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Project Name * @description Project name to update */ project_name?: string; /** * Description * @description Project description to update */ description?: string; /** * Is Public * @description Should the project be public? */ is_public?: boolean; /** * Is Public To Org * @description Should the project be shared to the organization? */ is_public_to_org?: boolean; /** * Slug * @description A new slug to use in project urls. */ slug?: string; }; /** EditProjectionAliasRequest */ EditProjectionAliasRequest: { /** * Project Id * @description Project ID to edit alias for */ project_id: string; /** * Projection Id * @description Projection ID to edit alias for */ projection_id: string; /** * Alias Value * @description Value to set for alias */ alias_value: string; /** * Replace * @description Replace projection this alias currently points to * @default false */ replace?: boolean; }; /** Embedder */ Embedder: { /** * Id * Format: uuid * @description Embedder id ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Atlas Index Id * Format: uuid * @description The index this atomizer corresponds to. */ atlas_index_id: string; /** * Ready * @description Is this embedder ready? */ ready: boolean; /** * Model Name * @description The embedder model this embedder embeds with. */ model_name: string; /** * Hyperparameters * @description The hyperparameters this model was trained with. */ hyperparameters: Record; }; /** EmbeddingModelInferenceUsage */ EmbeddingModelInferenceUsage: { /** * Model * @description The embedding model used. */ model: components['schemas']['NomicTextEmbeddingModel'] | components['schemas']['NomicVisionEmbeddingModel']; /** * Tokens * @description The total tokens used. */ tokens: number; /** * Num Embeddings * @description The total embeddings generated. */ num_embeddings?: number; }; /** EmbeddingNeighborByIDRequest */ EmbeddingNeighborByIDRequest: { /** * Atlas Index Id * Format: uuid * @description Unique atlas index id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ atlas_index_id: string; /** * Datum Ids * @description The datum ids to query. */ datum_ids?: string[]; /** * Atom Ids * @description The atom ids to query. */ atom_ids?: string[]; /** * K * @description The number of neighbors to return * @default 4 */ k?: number; }; /** EmbeddingNeighborRequest */ EmbeddingNeighborRequest: { /** * Atlas Index Id * Format: uuid * @description Unique atlas index id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ atlas_index_id: string; /** * Queries * @description A set of embeddings to query. Where `n` is the number of vectors to search and `d` is the vector dimensionality, this can be either an `n`x`d` numpy array encoded to base64, OR a list of `n` lists with `d` numbers per list. */ queries: string | number[][]; /** * K * @description The number of neighbors to return * @default 4 */ k?: number; }; /** EmbeddingNeighborResponse */ EmbeddingNeighborResponse: { /** * Neighbors * @description nested list of nearest neighbors */ neighbors: string[][]; /** * Distances * @description distances of the neighbors to queries */ distances: number[][]; }; /** EmbeddingTopicRequest */ EmbeddingTopicRequest: { /** * Atlas Index Id * Format: uuid * @description Unique atlas index id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ atlas_index_id: string; /** * Queries * @description The bytes of a batch of embeddings to get topics for */ queries: string; /** * Topic Model Id * @description The topic model to search under * @default */ topic_model_id?: string; /** * K * @description Number of neighbors to use when inferring topics * @default 32 */ k?: number; /** * Depth * @description The depth at which you want to estimate a topic * @default 1 */ depth?: number; }; /** EmbeddingUsageModel */ EmbeddingUsageModel: { /** * Prompt Tokens * @description The number of non-generated tokens ingested. */ prompt_tokens: number; /** * Total Tokens * @description The total tokens used. */ total_tokens: number; }; /** * Feature * @description Feature Model */ Feature: { /** * Type * @default Feature * @constant */ type?: 'Feature'; /** Geometry */ geometry?: components['schemas']['Point'] | components['schemas']['MultiPoint'] | components['schemas']['LineString'] | components['schemas']['MultiLineString'] | components['schemas']['Polygon'] | components['schemas']['MultiPolygon'] | components['schemas']['GeometryCollection']; /** Properties */ properties?: Record | components['schemas']['BaseModel']; /** Id */ id?: string; /** Bbox */ bbox?: [number, number, number, number] | [number, number, number, number, number, number]; }; /** * FeatureCollection * @description FeatureCollection Model */ FeatureCollection: { /** * Type * @default FeatureCollection * @constant */ type?: 'FeatureCollection'; /** Features */ features: components['schemas']['Feature'][]; /** Bbox */ bbox?: [number, number, number, number] | [number, number, number, number, number, number]; }; /** * GeometryCollection * @description GeometryCollection Model */ GeometryCollection: { /** * Type * @default GeometryCollection * @constant */ type?: 'GeometryCollection'; /** Geometries */ geometries: (components['schemas']['Point'] | components['schemas']['MultiPoint'] | components['schemas']['LineString'] | components['schemas']['MultiLineString'] | components['schemas']['Polygon'] | components['schemas']['MultiPolygon'])[]; }; /** GetBlobResponse */ GetBlobResponse: { /** * Url * @description The presigned S3 URL of the blob */ url: string; }; /** GetDatumRequest */ GetDatumRequest: { /** * Project Id * Format: uuid * @description The id of the project to update. */ project_id: string; /** * Datum Ids * @description The datum ids to retrieve. */ datum_ids: string[]; }; /** GetDatumResponse */ GetDatumResponse: { /** * Datums * @description The returned datums without json deserialization. */ datums: Record[]; }; /** GetProjectionAliasRequest */ GetProjectionAliasRequest: { /** * Project Id * @description Project ID to get alias for */ project_id: string; /** * Projection Id * @description Projection ID to get alias for */ projection_id: string; }; /** GetProjectionAliasResponse */ GetProjectionAliasResponse: { /** * Alias Value * @description Value of alias */ alias_value: string; }; /** HTTPValidationError */ HTTPValidationError: { /** Detail */ detail?: components['schemas']['ValidationError'][]; }; /** IndexJob */ IndexJob: { /** * Id * Format: uuid * @description Job ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Index Id * Format: uuid * @description Index ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ index_id: string; /** * Job Start Timestamp * Format: date-time * @description The timestamp of when the job started. * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ job_start_timestamp: string; /** * Job End Timestamp * Format: date-time * @description The timestamp of when the job ended. * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ job_end_timestamp: string; /** * Total Datums Remaining To Atomize * @description The total datums remaining to atomize * @example 1 */ total_datums_remaining_to_atomize: number; /** * Total Atoms Remaining To Embed * @description The total datums remaining to embed * @example 1 */ total_atoms_remaining_to_embed: number; /** * Nearest Neighbor Indices Remaining To Build * @description The total nearest neighbor indices remaining to build * @example 1 */ nearest_neighbor_indices_remaining_to_build: number; /** * Projections Remaining To Build * @description The total projections remaining to build. * @example 1 */ projections_remaining_to_build: number; /** * Topic Models Remaining To Build * @description The total topic models remaining to build. * @example 1 */ topic_models_remaining_to_build: number; /** * Rebuild Topic Models * @description Whether topic models are rebuilding */ rebuild_topic_models: boolean; }; /** InvitationModel */ InvitationModel: { /** * Id * Format: uuid * @description Initation id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * User Id * @description User id * @example auth0|12345678 */ user_id: string; /** * Access Role * @description Role * @example MEMBER */ access_role: string; /** * Organization Nickname * @description Organization name * @example MyOrganization */ organization_nickname: string; /** * Organization Id * Format: uuid * @description Inviter organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * User Nickname * @description Nickname of user */ user_nickname: string; }; /** InvitationModelPendingOrg */ InvitationModelPendingOrg: { /** * Id * Format: uuid * @description Initation id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * User Id * @description User id * @example auth0|12345678 */ user_id: string; /** * Access Role * @description Role * @example MEMBER */ access_role: string; /** * Organization Nickname * @description Organization name * @example MyOrganization */ organization_nickname: string; /** * Organization Id * Format: uuid * @description Inviter organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * User Nickname * @description Nickname of user */ user_nickname: string; /** * Email * @description User email * @example nomic@gmail.com */ email: string; /** * Picture * @description The users profile image */ picture?: string; }; /** InvitationsResponse */ InvitationsResponse: { /** * Invitations * @description Invitation list */ invitations: components['schemas']['InvitationModel'][]; }; /** InviteUserRequest */ InviteUserRequest: { /** * Email * @description Email of the user to invite * @example example@nomic.ai */ email: string; /** * Access Role * @description Role to set * @example MEMBER */ access_role: string; /** * Organization Id * Format: uuid * @description Inviter organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** JobProgressResponse */ JobProgressResponse: { /** * Result * @description Percentage of progress */ result: number; /** * Job Start Timestamp * Format: date-time * @description Job start timestamp */ job_start_timestamp: string; /** * Job End Timestamp * Format: date-time * @description Job end timestamp */ job_end_timestamp: string; /** * Index Build Stage * @description Stage of progress */ index_build_stage: string; }; /** JobSystemIndexStatusResponse */ JobSystemIndexStatusResponse: { /** * Index Id * @description The atlas index id * @example 4addcf85-84ed-4e3a-9519-17c72682f905 */ index_id: string; /** * Status * @description The status of the index job : initiated, completed, failed */ status: string; /** * Jobs * @description The progress of the index job */ jobs: components['schemas']['JobTypeStatus'][]; }; /** JobTypeStatus */ JobTypeStatus: { /** * Job Type * @description The type of job */ job_type: string; /** * State * @description The job type state */ state: string; /** * Creation Time * Format: date-time * @description The job creation time */ creation_time: string; /** * Ready Time * Format: date-time * @description The time the job became eligible to run */ ready_time?: string; /** * Start Time * Format: date-time * @description The job start time */ start_time: string; /** * End Time * Format: date-time * @description The job end time */ end_time?: string; /** * Worker Id * @description The UUID of the worker that last attempted the job */ worker_id?: string; /** * Attempt * @description # of attempts made to run the job (0 if it has not been assigned) */ attempt?: number; /** * Priority * @description Job priority (higher runs first) */ priority?: number; }; /** * LineString * @description LineString Model */ LineString: { /** * Type * @default LineString * @constant */ type?: 'LineString'; /** Coordinates */ coordinates: ([number, number] | [number, number, number])[]; }; /** * LongTextHandlingMode * @description An enumeration. * @enum {unknown} */ LongTextHandlingMode: 'truncate' | 'mean'; /** ModifyUserRequest */ ModifyUserRequest: { /** * User Id * @description Unique user id * @example auth0|12345678 */ user_id: string; /** * @description The access role the new user should have: MEMBER, ADMIN, OWNER * @example MEMBER */ access_role: components['schemas']['AccessRole']; /** * Organization Id * Format: uuid * @description Unique organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** * MultiLineString * @description MultiLineString Model */ MultiLineString: { /** * Type * @default MultiLineString * @constant */ type?: 'MultiLineString'; /** Coordinates */ coordinates: ([number, number] | [number, number, number])[][]; }; /** * MultiPoint * @description MultiPoint Model */ MultiPoint: { /** * Type * @default MultiPoint * @constant */ type?: 'MultiPoint'; /** Coordinates */ coordinates: ([number, number] | [number, number, number])[]; }; /** * MultiPolygon * @description MultiPolygon Model */ MultiPolygon: { /** * Type * @default MultiPolygon * @constant */ type?: 'MultiPolygon'; /** Coordinates */ coordinates: ([number, number] | [number, number, number])[][][]; }; /** NearestNeighborIndex */ NearestNeighborIndex: { /** * Id * Format: uuid * @description Nearest Neighbor Index ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Index Name * @description The type of nearest neighbor index * @example faiss */ index_name: string; /** * Ready * @description Is this NN index ready? */ ready: boolean; /** * Hyperparameters * @description The hyperparameters of this index. */ hyperparameters: Record; /** * Atom Strategies * @description The phrase strategies of the phrases this embedder is embedding. */ atom_strategies: string[]; }; /** * NomicProjectModel * @description An enumeration. * @enum {string} */ NomicProjectModel: 'nomic-project-v1' | 'nomic-project-v2' | 'umap'; /** * NomicTextEmbeddingModel * @description An enumeration. * @enum {unknown} */ NomicTextEmbeddingModel: 'all-MiniLM-L6-v2' | 'nomic-embed-text-v1' | 'nomic-embed-text-v1.5' | 'nomic-embed-code'; /** * NomicVisionEmbeddingModel * @description An enumeration. * @enum {unknown} */ NomicVisionEmbeddingModel: 'nomic-embed-vision-v1' | 'nomic-embed-vision-v1.5'; /** ObtainAccessTokenRequest */ ObtainAccessTokenRequest: { /** * Code * @description The code to use to obtain the access token. */ code: string; }; /** Organization */ Organization: { /** @description The plan type this organization is on. */ plan_type: components['schemas']['OrganizationPlan']; /** Max Datums Per Project */ max_datums_per_project: number; /** Max Members */ max_members: number; /** Max Projects */ max_projects: number; /** Max External Collaborators */ max_external_collaborators: number; /** Max Datums Across All Projects */ max_datums_across_all_projects?: number; /** * Private Projects * @default false */ private_projects?: boolean; /** Max Text Tokens */ max_text_tokens?: number; /** Max Image Embeddings */ max_image_embeddings?: number; /** Max Storage */ max_storage?: number; /** Max Premium Api Calls */ max_premium_api_calls?: number; /** Max Non Embedding Projects */ max_non_embedding_projects?: number; /** * Features * @description The features this organization is allowed to utilize. */ features: string[]; /** * Free Text Tokens Per Seat * @default 0 */ free_text_tokens_per_seat?: number; /** * Free Image Embeddings Per Seat * @default 0 */ free_image_embeddings_per_seat?: number; /** * Free Storage Per Seat * @default 0 */ free_storage_per_seat?: number; /** * Free Seats * @default 0 */ free_seats?: number; /** * Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Nickname * @description The organization nickname * @example nomicai */ nickname: string; /** * Time Created * Format: date-time * @description When this organization was created. */ time_created: string; /** * Members * @description All of the organization members with access roles. */ members: components['schemas']['OrganizationMembershipWithPicture'][]; /** * Projects * @description All of the organization's projects the requested user can access */ projects: components['schemas']['ProjectMetadataBaseModel'][]; /** * Slug * @description The organization url-safe slug */ slug: string; /** * Organization Type * @description The type of organization: personal, company and academic */ organization_type: string; /** * Linked User Account Id * @description The user id of the linked account Atlas account to this organization. Null if there is no linked account. * @example auth0|12345678 */ linked_user_account_id: string; /** * Access Role * @description Access role of user for this organization * @default VIEWER */ access_role?: string; /** * Permissions * @description User permissions in organization */ permissions: { [key: string]: boolean; }; /** * Public Organization * @description Is the organization public? */ public_organization: boolean; /** * Description * @description A description for this organization. */ description?: string; /** * Logo Url * @description The url of the organization logo. */ logo_url?: string; /** * Website * @description The url of the organization website. */ website?: string; /** * Stripe Subscription Id * @description Stripe subscription id * @example sub_e31fd13 */ stripe_subscription_id: string; /** * Stripe Customer Id * @description Stripe subscription id * @example cus_fe32413 */ stripe_customer_id: string; /** * Stripe Subscription Start Timestamp * Format: date-time * @description The timestamp the stripe subscription billing period starts */ stripe_subscription_start_timestamp: string; /** * Stripe Subscription End Timestamp * Format: date-time * @description The timestamp the stripe subscription billing period ends */ stripe_subscription_end_timestamp: string; /** * Project Count * @description The total number of projects of this organization */ project_count: number; }; /** OrganizationAccessRequestApproveRequest */ OrganizationAccessRequestApproveRequest: { /** * Organization ID * Format: uuid * @description The ID of the organization to add the user to */ organization_id: string; /** * User ID * @description The user ID to approve the request for */ user_id: string; }; /** OrganizationAccessRequestCancelRequest */ OrganizationAccessRequestCancelRequest: { /** * Organization ID * Format: uuid * @description The ID of the organization to add the user to */ organization_id: string; /** * User ID * @description The user ID to approve the request for */ user_id: string; }; /** OrganizationAccessRequestCreateRequest */ OrganizationAccessRequestCreateRequest: { /** * Organization ID * Format: uuid * @description The ID of the organization to add the user to */ organization_id: string; }; /** OrganizationAccessRequestRejectRequest */ OrganizationAccessRequestRejectRequest: { /** * Organization ID * Format: uuid * @description The ID of the organization to add the user to */ organization_id: string; /** * User ID * @description The user ID to approve the request for */ user_id: string; }; /** OrganizationIDResponse */ OrganizationIDResponse: { /** * Organization Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** OrganizationMemberDeleteRequest */ OrganizationMemberDeleteRequest: { /** * User Id * @description Unique user id * @example auth0|12345678 */ user_id: string; /** * Organization Id * Format: uuid * @description Unique organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** OrganizationMembership */ OrganizationMembership: { /** * Organization Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * Nickname * @description Organization name * @example MyOrganization */ nickname: string; /** * User Id * @description Unique user id * @example auth0|12345678 */ user_id: string; /** * Access Role * @description User access role in organization * @example member */ access_role: string; /** * @description Plan type * @example enterprise */ plan_type: components['schemas']['OrganizationPlan']; /** * Permissions * @description User permissions in organization */ permissions: { [key: string]: boolean; }; /** * Slug * @description The organization url-safe slug */ slug: string; }; /** OrganizationMembershipWithPicture */ OrganizationMembershipWithPicture: { /** * Organization Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * Nickname * @description Organization name * @example MyOrganization */ nickname: string; /** * Picture * @description The users profile image */ picture?: string; /** * User Id * @description Unique user id * @example auth0|12345678 */ user_id: string; /** * Access Role * @description User access role in organization * @example member */ access_role: string; /** * Permissions * @description User permissions in organization */ permissions: { [key: string]: boolean; }; /** * Email * @description User email * @example nomic@gmail.com */ email: string; }; /** * OrganizationPlan * @description The list of available plans for organizations. * @enum {unknown} */ OrganizationPlan: 'atlas_demo' | 'atlas_enterprise' | 'atlas_research' | 'atlas_starter' | 'atlas_startup' | 'atlas_pro' | 'mock' | 'free_test_user' | 'pro' | 'enterprise' | 'free' | 'research'; /** OrganizationUsageResponse */ OrganizationUsageResponse: { /** Plan Type */ plan_type: string; /** * Billing Period * Format: date-time */ billing_period?: string; text_tokens: components['schemas']['UsageRecord']; image_embeddings: components['schemas']['UsageRecord']; seats: components['schemas']['UsageRecord']; }; /** PagedEmbeddingRequest */ PagedEmbeddingRequest: { /** * Projection Id * Format: uuid * @description Unique projection id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ projection_id: string; /** * Last File * @description The previous page token to start from; or undefined to start from the beginning. */ last_file?: string; /** * Page Size * @description The number of embeddings to return in each page. * @default 10000 */ page_size?: number; }; /** PendingInvitationsRequest */ PendingInvitationsRequest: { /** * Organization Id * Format: uuid * @description Organization id to get pending invitations for * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** PendingInvitationsResponse */ PendingInvitationsResponse: { /** * Invitations * @description Invitation list */ invitations: components['schemas']['InvitationModelPendingOrg'][]; }; /** * Point * @description Point Model */ Point: { /** * Type * @default Point * @constant */ type?: 'Point'; /** Coordinates */ coordinates: [number, number] | [number, number, number]; }; /** * Polygon * @description Polygon Model */ Polygon: { /** * Type * @default Polygon * @constant */ type?: 'Polygon'; /** Coordinates */ coordinates: ([number, number] | [number, number, number])[][]; }; /** * PrivateUser * @description Put user attributes here that are only returned in private endpoints */ PrivateUser: { /** * Sub * @description Unique user id * @example auth0|12345678 */ sub: string; /** * Nickname * @description The users nickname * @example nomicai */ nickname: string; /** * Name * @description The users name as registered in auth0 * @example nomicai */ name: string; /** * Picture * @description The users profile image */ picture?: string; /** * Updated At * Format: date-time * @description The last time user information was updated on Auth0 side. */ updated_at: string; /** * Default Organization * Format: uuid * @description The users default organization. */ default_organization?: string; /** * Stripe Customer Id * @description The users stripe account. */ stripe_customer_id?: string; /** * Email * @description The user email */ email: string; /** * Organizations * @description All of the organizations this user belongs to * @default [] */ organizations?: components['schemas']['OrganizationMembership'][]; /** * Waitlisted * @description Whether or not the user is wait-listed for Atlas access * @default false */ waitlisted?: boolean; }; /** Project */ Project: { /** * Id * Format: uuid * @description Project ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Owner * Format: uuid * @description The organization ID that owns this project * @example 43adcf85-84ed-4e3a-9519-17c72682f905 */ owner: string; /** * Project Name * @description The name of this project * @example example_project */ project_name: string; /** * Creator * @description The user id who created this project. */ creator: string; /** * Description * @description A description for this project. */ description: string; /** * Is Public * @description Is the project viewable without being in the organzation? */ is_public: boolean; /** * Is Public To Org * @description Is the project viewable to the organization? */ is_public_to_org: boolean; /** * Project Fields * @description The list of fields a datum in the project may contain. */ project_fields: string[]; /** * Unique Id Field * @description The field that contains a unique id for each document. */ unique_id_field: string; /** * Modality * @description The project modality */ modality?: string; /** * Total Datums In Project * @description Total datums in project. */ total_datums_in_project: number; /** * Created Timestamp * Format: date-time * @description The timestamp this project was created. */ created_timestamp: string; /** * Slug * @description The project url-safe slug */ slug: string; /** * Og Image * @description The datasets opengraph image */ og_image: string; /** * Atlas Indices * @description All Atlas Indices built overtop of this project. */ atlas_indices: components['schemas']['AtlasIndex'][]; /** * Insert Update Delete Lock * @description Whether the project is locked for CRUD operations. */ insert_update_delete_lock: boolean; /** * Access Role * @description Access role of user for this project */ access_role: string; /** * Permissions * @description Access role of user for this dataset */ permissions: { [key: string]: boolean; }; /** * Schema * @description An Arrow schema for the project. Binary data encoded as base64. */ schema?: string; /** * Organization Slug * @description The organization url-safe slug */ organization_slug: string; /** * Organization Name * @description The organization nickname */ organization_name: string; /** * Creator Nickname * @description The creator nickname */ creator_nickname: string; /** * Creator Picture * @description The creator picture */ creator_picture: string; }; /** ProjectCreatedResponse */ ProjectCreatedResponse: { /** * Project Id * Format: uuid * @description The ID of the newly created project * @example 4addcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; /** * Slug * @description The unique url slug of the project * @example test-project-123 */ slug: string; }; /** ProjectDataArrowExportRequest */ ProjectDataArrowExportRequest: { /** * Id * Format: uuid * @description Project ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Index Id * Format: uuid * @description Atlas index ID--needed for index-specific data * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ index_id?: string; /** * Tags * @description Whether to export tags * @default false */ tags?: boolean; /** * Metadata * @description Whether to export the core metadata (aside from tags, embeddings) * @default false */ metadata?: boolean; /** * Embeddings * @description Whether to export embeddings * @default false */ embeddings?: boolean; /** * Topics * @description Whether to export topics * @default false */ topics?: boolean; }; /** ProjectDataDeleteRequest */ ProjectDataDeleteRequest: { /** * Datum Ids * @description The datum ids to delete */ datum_ids: string[]; /** * Project Id * Format: uuid * @description The project id * @example df4dcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; }; /** ProjectDataUpdateRequest */ ProjectDataUpdateRequest: { /** * Datums * @description The datums to update */ datums: Record[]; /** * Project Id * Format: uuid * @description The project id * @example df4dcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; }; /** ProjectIdName */ ProjectIdName: { /** * Id * Format: uuid * @description Id of the project */ id: string; /** * Project Name * @description Name of the project */ project_name: string; /** * Slug * @description The project url-safe slug */ slug: string; }; /** ProjectMetadataBaseModel */ ProjectMetadataBaseModel: { /** * Id * Format: uuid * @description Project ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Owner * Format: uuid * @description The organization ID that owns this project * @example 43adcf85-84ed-4e3a-9519-17c72682f905 */ owner: string; /** * Project Name * @description The name of this project * @example example_project */ project_name: string; /** * Creator * @description The user id who created this project. */ creator: string; /** * Description * @description A description for this project. */ description: string; /** * Is Public * @description Is the project viewable without being in the organization? */ is_public: boolean; /** * Is Public To Org * @description Is the project public to the organization? */ is_public_to_org: boolean; /** * Project Fields * @description The list of fields a datum in the project may contain. */ project_fields: string[]; /** * Unique Id Field * @description The field that contains a unique id for each document. */ unique_id_field: string; /** * Modality * @description The project modality */ modality?: string; /** * Total Datums In Project * @description Total datums in project. */ total_datums_in_project: number; /** * Created Timestamp * Format: date-time * @description The timestamp this project was created. */ created_timestamp: string; /** * Nickname * @description The nickname who created this project. */ nickname: string; /** * Thumbnail * @description The project display thumbnail. */ thumbnail: string; /** * Slug * @description The project url-safe slug */ slug: string; /** * Organization Slug * @description The organization url-safe slug */ organization_slug: string; /** * Organization Name * @description The organization nickname */ organization_name: string; /** * Creator Nickname * @description The creator nickname */ creator_nickname: string; /** * Creator Picture * @description The creator picture */ creator_picture: string; }; /** ProjectNameSearchRequest */ ProjectNameSearchRequest: { /** * Project Name * @description The name of your project */ project_name: string; /** * Organization Name * @description The organization with-in which you are searching. */ organization_name?: string; }; /** ProjectNameSearchResponse */ ProjectNameSearchResponse: { /** * Results * @description A list of projects matching your search query. */ results: components['schemas']['ProjectSearchItem'][]; }; /** ProjectSearchItem */ ProjectSearchItem: { /** * Id * Format: uuid * @description Project ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Owner * @description The nickname of the organization that owns this project. * @example 43adcf85-84ed-4e3a-9519-17c72682f905 */ owner: string; /** * Project Name * @description The name of this project * @example example_project */ project_name: string; /** * Creator * @description The nickname of the user who created this project. */ creator: string; /** * Description * @description A description for this project. */ description: string; }; /** Projection */ Projection: { /** * Id * Format: uuid * @description Projection ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Projection Name * @description The type of projection */ projection_name: string; /** * Ready * @description Is this projection ready? */ ready: boolean; /** * Hyperparameters * @description The hyperparameters of this projection. */ hyperparameters: Record; /** * Atom Strategies * @description The phrase strategies of the phrases this embedder is embedding. */ atom_strategies: string[]; /** * Created Timestamp * Format: date-time * @description The timestamp this projection was created. */ created_timestamp: string; /** * Updated Timestamp * Format: date-time * @description The timestamp this projection was updated. */ updated_timestamp: string; /** * Thumbnail * @description The thumbnail of this projection. * @default */ thumbnail?: string; /** * Og Image * @description The og image of this projection. * @default */ og_image?: string; }; /** ProjectionAliasResponse */ ProjectionAliasResponse: { /** * Project Id * Format: uuid * @description The project id * @example df4dcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; /** * Projection Id * Format: uuid * @description The projection id * @example The projection id */ projection_id: string; }; /** ProjectionResponse */ ProjectionResponse: { /** * Topic Models * @description List of topic model geojsons */ topic_models: components['schemas']['FeatureCollection'][]; /** * Topic Model Metadatas * @description list of topic model metadata */ topic_model_metadatas: Record[]; }; /** ProjectsResponse */ ProjectsResponse: { /** * Projects * @description All projects for user */ projects: components['schemas']['ProjectIdName'][]; }; /** PublicOrganizationMembershipWithPicture */ PublicOrganizationMembershipWithPicture: { /** * Organization Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * Nickname * @description Organization name * @example MyOrganization */ nickname: string; /** * Picture * @description The users profile image */ picture?: string; }; /** PublicOrganizationResponse */ PublicOrganizationResponse: { /** * Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ id: string; /** * Nickname * @description The organization nickname * @example nomicai */ nickname: string; /** @description The plan type this organization is on. */ plan_type: components['schemas']['OrganizationPlan']; /** * Time Created * Format: date-time * @description When this organization was created. */ time_created: string; /** * Members * @description All of the organization members with access roles. */ members: components['schemas']['PublicOrganizationMembershipWithPicture'][]; /** * Projects * @description All of the organization's projects the requested user can access */ projects: components['schemas']['ProjectMetadataBaseModel'][]; /** * Slug * @description The organization url-safe slug */ slug: string; /** * Organization Type * @description The type of organization: personal, company and academic */ organization_type: string; /** * Linked User Account Id * @description The user id of the linked account Atlas account to this organization. Null if there is no linked account. * @example auth0|12345678 */ linked_user_account_id: string; /** * Access Role * @description Access role of user for this organization * @default VIEWER */ access_role?: string; /** * Permissions * @description User permissions in organization */ permissions: { [key: string]: boolean; }; /** * Public Organization * @description Is the organization public? */ public_organization: boolean; /** * Description * @description A description for this organization. */ description?: string; /** * Logo Url * @description The url of the organization logo. */ logo_url?: string; /** * Website * @description The url of the organization website. */ website?: string; }; /** RemoveIndexRequest */ RemoveIndexRequest: { /** * Project Id * Format: uuid * @description The project id containing the index you are removing. */ project_id: string; /** * Index Id * Format: uuid * @description ID of index to remove */ index_id: string; }; /** RemoveProjectRequest */ RemoveProjectRequest: { /** * Project Id * Format: uuid * @description The ID of the project to remove. * @example example-project */ project_id: string; }; /** SearchDatasetsResponse */ SearchDatasetsResponse: { /** * Results * @description A list of search results * @default [] */ results?: components['schemas']['DatasetSearchResult'][]; }; /** SearchUserModel */ SearchUserModel: { /** * Nickname * @description Nickname of user */ nickname: string; /** * Id * @description User id */ id: string; }; /** SearchUserProjectRequest */ SearchUserProjectRequest: { /** * Search Word * @description Search word to find user */ search_word: string; /** * Organization Id * Format: uuid * @description Inviter organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * Project Id * Format: uuid * @description Inviter project id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ project_id: string; }; /** SearchUserRequest */ SearchUserRequest: { /** * Search Word * @description Search word to find user */ search_word: string; /** * Organization Id * Format: uuid * @description Inviter organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** SearchUserResponse */ SearchUserResponse: { /** * Users * @description Users list */ users: components['schemas']['SearchUserModel'][]; }; /** SetOrganizationLimitsRequest */ SetOrganizationLimitsRequest: { /** * Max Datums * @description The datapoint usage limit to set for the organization */ max_datums: number; /** * Organization Id * Format: uuid * @description Organization id * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** SetOrganizationLimitsResponse */ SetOrganizationLimitsResponse: { /** * Max Datums * @description The new datapoint usage limit */ max_datums: number; }; /** StripeSubscriptionCancelRequest */ StripeSubscriptionCancelRequest: { /** * Organization Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; }; /** StripeSubscriptionCreateRequest */ StripeSubscriptionCreateRequest: { /** * Organization Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * @description Subscription plan * @default pro */ plan_type?: components['schemas']['OrganizationPlan']; /** * Promo Code * @description Promotion code */ promo_code?: string; }; /** StripeSubscriptionCreateResponse */ StripeSubscriptionCreateResponse: { /** * Subscription Id * @description The ID of the subscription */ subscription_id: string; /** * Client Secret * @description The stripe client secret for the payment entering session */ client_secret: string; /** * Applied Promo Code * @description The applied promo code, if successful */ applied_promo_code?: string; /** * Promo Code Description * @description Description of promo code (metadata.descrption in Stripe), if available */ promo_code_description?: string; }; /** SuccessResponse */ SuccessResponse: { /** * Result * @default ok */ result?: string; }; /** TagRequest */ TagRequest: { /** * Project Id * @description Project id */ project_id: string; /** * Projection Id * @description Projection id */ projection_id: string; /** * Tag Name * @description Name of tag */ tag_name: string; /** * Tag Definition Id * @description Hashed id for tag definition */ tag_definition_id: string; /** * Dsl Rule * @description DSL rule to generate tag mask */ dsl_rule: string; }; /** TagResponse */ TagResponse: { /** Tag Id */ tag_id: string; /** * Tag Definition Id * @description Hashed id of tag definition */ tag_definition_id: string; /** * Tag Name * @description Name of tag */ tag_name?: string; /** * User Id * @description Tag creator nickname */ user_id?: string; /** * Dsl Rule * @description DSL rule json */ dsl_rule?: string; /** * Projection Id * @description Projection ID */ projection_id: string; }; /** TagStatus */ TagStatus: { /** * Is Complete * @description Is tag applied to all tiles */ is_complete: boolean; }; /** TagWithIdRequest */ TagWithIdRequest: { /** * Project Id * @description Project ID */ project_id: string; /** * Tag Id * @description Tag id */ tag_id: string; /** * Tag Name * @description Name of tag */ tag_name?: string; /** * Tag Definition Id * @description Hashed id for tag definition */ tag_definition_id?: string; /** * Dsl Rule * @description DSL rule to generate tag mask */ dsl_rule?: string; }; /** TextEmbeddingInferenceRequest */ TextEmbeddingInferenceRequest: { /** * Texts * @description A batch of text you want embedded. */ texts: string[]; /** * @description The model to use when embedding. * @default nomic-embed-text-v1 */ model?: components['schemas']['NomicTextEmbeddingModel']; /** * Task Type * @description The downstream task to generate embeddings for, model-specific. */ task_type?: string; /** * @description How to handle text longer than the model can accept. * @default mean */ long_text_mode?: components['schemas']['LongTextHandlingMode']; /** * Max Tokens Per Text * @description Maximum amount of tokens per text. Defaults to 8192 if `long_text_mode` is "mean", or the maximum model input size if `long_text_mode` is "truncate". * @default 8192 */ max_tokens_per_text?: number; /** * Dimensionality * @description Requested embedding dimensionality, defaults to full-size for requested model */ dimensionality?: number; }; /** TextEmbeddingInferenceResponse */ TextEmbeddingInferenceResponse: { /** * Embeddings * @description The embeddings */ embeddings: number[][]; /** * Usage * @description The embedding usage */ usage: components['schemas']['EmbeddingUsageModel']; /** @description The model used to produce the embeddings. */ model: components['schemas']['NomicTextEmbeddingModel']; }; /** TopicDensityRequest */ TopicDensityRequest: { /** * Start * Format: date-time * @description The datetime of window start */ start: string; /** * End * Format: date-time * @description The datetime of window end */ end: string; /** * Time Field * @description The time field to window against */ time_field: string; }; /** TopicDensityResponse */ TopicDensityResponse: { /** * Results * @description A list of topic metadata, including movement information */ results: Record[]; }; /** UpdateInviteRequest */ UpdateInviteRequest: { /** * Invitation Id * @description Invitation id * @example auth0|12345678 */ invitation_id: string; /** * Is Accepted * @description Is invitation accepted? */ is_accepted: boolean; }; /** UpdateOrganizationRequest */ UpdateOrganizationRequest: { /** * Organization Id * Format: uuid * @description Organization ID * @example 33adcf85-84ed-4e3a-9519-17c72682f905 */ organization_id: string; /** * New Organization Nickname * @description The new nickname for the organization. */ new_organization_nickname?: string; /** * New Organization Type * @description The new organization type */ new_organization_type?: string; /** * New Organization Slug * @description A new organization slug */ new_organization_slug?: string; /** * New Organization Description * @description A new description for the organization. */ new_organization_description?: string; /** * New Organization Logo Url * @description A new logo for the organization. */ new_organization_logo_url?: string; /** * New Organization Website * @description A new website for the organization. */ new_organization_website?: string; }; /** UpdateProjectIndicesRequest */ UpdateProjectIndicesRequest: { /** * Project Id * Format: uuid * @description The id of the project to update */ project_id: string; /** * Rebuild Topic Models * @description Whether or not to rebuild topic models * @default false */ rebuild_topic_models?: boolean; }; /** UpdateProjectIndicesResponse */ UpdateProjectIndicesResponse: { /** * Job Ids * @description The job ids cerated for each index update operation */ job_ids: string[]; }; /** UpdateTagDefinitionRequest */ UpdateTagDefinitionRequest: { /** * Tag Id * @description Tag id */ tag_id: string; /** * Tag Definition Id * @description New tag definition id */ tag_definition_id: string; /** * Dsl Rule * @description DSL rule to generate tag mask */ dsl_rule?: string; }; /** UpdateTagNameRequest */ UpdateTagNameRequest: { /** * Tag Id * @description Tag id */ tag_id: string; /** * Tag Name * @description New name of tag */ tag_name: string; }; /** UpdateTopicModelRequest */ UpdateTopicModelRequest: { /** * Project Id * @description Project id */ project_id: string; /** * Topic Geojson * @description Topic model geojson to replace existing topic model */ topic_geojson: components['schemas']['FeatureCollection']; }; /** UsageRecord */ UsageRecord: { /** * Used * @description total units used * @default 0 */ used?: number; /** * Offered * @description units included in plan */ offered?: number; /** * Unit Price * @description price per unit of usage over included amount */ unit_price?: number; /** * Unit Price Str * @description exact price per unit as a string */ unit_price_str?: string; /** * Billable * @description billable overage price in USD */ billable?: string; }; /** ValidatePromoCodeRequest */ ValidatePromoCodeRequest: { /** * Promo Code * @description The promo code to validate */ promo_code: string; /** * Plan Type * @description The plan type to validate the promo code against */ plan_type: string; }; /** ValidationError */ ValidationError: { /** Location */ loc: (string | number)[]; /** Message */ msg: string; /** Error Type */ type: string; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export type external = Record; export interface operations { /** * Health Check * @description Runs a health check on this instance of the API. */ health_check_v1_health__get: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; }; }; /** * Fetch Organization * @description Fetches all details about an organization. * Presents limited amounts of information based on the user's affiliation with the organization. * Pagination with limit and offset parameters */ fetch_organization_v1_organization__organization_id_or_slug__get: { parameters: { query?: { offset_number?: number; limit?: number; }; path: { organization_id_or_slug: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['Organization'] | components['schemas']['PublicOrganizationResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Get Organization Usage Handler * @description Fetches the organization usage for the given period. */ get_organization_usage_handler_v1_organization__organization_id_or_slug__usage2_get: { parameters: { query?: { /** @description The _exact_ start date of the period to fetch usage for. */ billing_period?: string; offset_number?: number; limit?: number; }; path: { organization_id_or_slug: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['OrganizationUsageResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Organization Usage * @description Computes the organization usage in the past 1 month. * * since_last_billing_date: If True and organization is on a paid tier, only returns usage after the last billing date. */ fetch_organization_usage_v1_organization__organization_id_or_slug__usage_get: { parameters: { query?: { since_last_billing_date?: boolean; offset_number?: number; limit?: number; }; path: { organization_id_or_slug: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['AtlasUsageResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Organization Id By Slug * @description Returns the organization_id given a slug, even for private organizations. */ fetch_organization_id_by_slug_v1_organization_search__slug__get: { parameters: { path: { slug: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['OrganizationIDResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Organization Data * @description Changes the organization nickname given the organization ID */ update_organization_data_v1_organization_rename_post: { requestBody: { content: { 'application/json': components['schemas']['UpdateOrganizationRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Organization Data * @description Changes the organization nickname given the organization ID */ update_organization_data_v1_organization_update_post: { requestBody: { content: { 'application/json': components['schemas']['UpdateOrganizationRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Create Organization * @description Creates an organization on the free tier and sets the owner to the user sending the request. */ create_organization_v1_organization_create_post: { requestBody: { content: { 'application/json': components['schemas']['CreateOrganizationRequest']; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['CreateOrganizationResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Search User * @description Search user by nickname who is not already in organization */ search_user_v1_organization_search_post: { requestBody: { content: { 'application/json': components['schemas']['SearchUserRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SearchUserResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Add Organization Member */ add_organization_member_v1_organization_members_add_post: { requestBody: { content: { 'application/json': components['schemas']['AddUserRequest']; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove Organization Member * @description Removes a user from an organization. */ remove_organization_member_v1_organization_members_delete_post: { requestBody: { content: { 'application/json': components['schemas']['OrganizationMemberDeleteRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove Organization Member * @deprecated * @description Removes a user from an organization. */ remove_organization_member_v1_organization_members_remove_post: { requestBody: { content: { 'application/json': components['schemas']['OrganizationMemberDeleteRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Modify Organization Member * @description Modifies a user in an organization */ modify_organization_member_v1_organization_members_update_post: { requestBody: { content: { 'application/json': components['schemas']['ModifyUserRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Modify Organization Member * @deprecated * @description Modifies a user in an organization */ modify_organization_member_v1_organization_members_modify_post: { requestBody: { content: { 'application/json': components['schemas']['ModifyUserRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Deprecated Invite Member In Organization * @deprecated * @description Invites a user in an organization */ deprecated_invite_member_in_organization_v1_organization_member_invite_post: { requestBody: { content: { 'application/json': components['schemas']['DeprecatedInviteUserRequest']; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Invite Member In Organization * @description Invites a user in an organization */ invite_member_in_organization_v1_organization_members_invite_post: { requestBody: { content: { 'application/json': components['schemas']['InviteUserRequest']; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Get Organization Invitations * @description Get organization invitations for user */ get_organization_invitations_v1_organization_invitations_post: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['InvitationsResponse']; }; }; }; }; /** * Accept Organization Invitation * @description Accepts an invitation to join an organization */ accept_organization_invitation_v1_organization_invitation__invitation_id__accept_post: { parameters: { path: { invitation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Reject Organization Invitation * @description Rejects an invitation to join an organization */ reject_organization_invitation_v1_organization_invitation__invitation_id__reject_post: { parameters: { path: { invitation_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Invitation Status * @deprecated * @description Accept or reject invitation */ update_invitation_status_v1_organization_invitation_status_post: { requestBody: { content: { 'application/json': components['schemas']['UpdateInviteRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Get Organization Pending Invitations * @description Get organization pending invitations */ get_organization_pending_invitations_v1_organization_invitations_pending_post: { requestBody: { content: { 'application/json': components['schemas']['PendingInvitationsRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['PendingInvitationsResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove Pending Invitation * @description Delete pending invitation */ remove_pending_invitation_v1_organization_invitations_delete_post: { requestBody: { content: { 'application/json': components['schemas']['DeletePendingInvitationRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Get Organization Access Requests Handler * @description Get organization access requests */ get_organization_access_requests_handler_v1_organization__organization_id_or_slug__access_requests_get: { parameters: { query?: { offset_number?: number; limit?: number; }; path: { organization_id_or_slug: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Create Organization Access Request Handler * @description Request access to organization */ create_organization_access_request_handler_v1_organization_access_requests_post: { requestBody: { content: { 'application/json': components['schemas']['OrganizationAccessRequestCreateRequest']; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Accept Organization Access Request Handler * @description Approve a request to access an organization */ accept_organization_access_request_handler_v1_organization_access_requests_accept_post: { requestBody: { content: { 'application/json': components['schemas']['OrganizationAccessRequestApproveRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Reject Organization Access Request Handler * @description Reject a request to access an organization */ reject_organization_access_request_handler_v1_organization_access_requests_reject_post: { requestBody: { content: { 'application/json': components['schemas']['OrganizationAccessRequestRejectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Cancel Organization Access Request Handler * @description Cancel a request to access an organization */ cancel_organization_access_request_handler_v1_organization_access_requests_cancel_post: { requestBody: { content: { 'application/json': components['schemas']['OrganizationAccessRequestCancelRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Fetch Current User */ fetch_current_user_v1_user__get: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['PrivateUser']; }; }; }; }; /** Create Api Key */ create_api_key_v1_user_authorization_keys__organization_id__create_post: { parameters: { path: { organization_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['APIKeyCreationRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['APIKeyCreationResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Delete Api Key */ delete_api_key_v1_user_authorization_keys__organization_id__delete_post: { parameters: { path: { organization_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['APIKeyDeletionRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Api Keys */ get_api_keys_v1_user_authorization_keys__organization_id__get: { parameters: { path: { organization_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['APIKeyListResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Auth0 Obtain Token From Code */ auth0_obtain_token_from_code_v1_user_token_post: { requestBody: { content: { 'application/json': components['schemas']['ObtainAccessTokenRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Auth0 Obtain Token From Refresh */ auth0_obtain_token_from_refresh_v1_user_token_refresh__refresh_token__get: { parameters: { path: { refresh_token: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Auth0 Authorize Redirect */ auth0_authorize_redirect_v1_user_authorize_get: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; }; }; /** Logout */ logout_v1_user_logout_get: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; }; }; /** Get Tags For Project */ get_tags_for_project_v1_project_tags__project_id__get: { parameters: { path: { project_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Add Tag To Project */ add_tag_to_project_v1_project_tags__project_id__post: { parameters: { query: { /** @description The dataset tag to be added to the project */ tag: string; }; path: { project_id: string; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Delete Tag From Project */ delete_tag_from_project_v1_project_tags__project_id__delete: { parameters: { query: { /** @description The dataset tag to be deleted from the project */ tag: string; }; path: { project_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Project * @description Fetches all details about a project. */ fetch_project_v1_project__project_id__get: { parameters: { path: { project_id: unknown; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['Project']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch All Project * @deprecated * @description Fetches all project for authenticated user. */ fetch_all_project_v1_project_sidebar_list_get: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectsResponse']; }; }; }; }; /** * Fetch All Project * @description Fetches all project for authenticated user. */ fetch_all_project_v1_project__get: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectsResponse']; }; }; }; }; /** * Update Project Metadata * @description Edit project metadata. */ update_project_metadata_v1_project_update_post: { parameters: { query: { project_id: unknown; }; }; requestBody: { content: { 'application/json': components['schemas']['EditProjectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Project Metadata * @description Edit project metadata. */ update_project_metadata_v1_project_update__project_id__post: { parameters: { path: { project_id: unknown; }; }; requestBody: { content: { 'application/json': components['schemas']['EditProjectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Search Semantic */ search_semantic_v1_project_search_vector_post: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; }; }; /** Search Semantic Id */ search_semantic_id_v1_project_search_id_get: { parameters: { query: { /** @description The ID of the project. */ project_id: string; /** @description The ID of the projection. */ projection_id: string; /** @description The tiles to be used, as a JSON-encoded list. */ tiles: string; /** @description The tile index where the search embedding is located */ tix: number; /** @description The row number of the embedding in its quadtree tile */ rix: number; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Project Name Search */ project_name_search_v1_project_search_name_post: { requestBody: { content: { 'application/json': components['schemas']['ProjectNameSearchRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectNameSearchResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Create New Project * @description Create a project associated with an organization. */ create_new_project_v1_project_create_post: { requestBody: { content: { 'application/json': components['schemas']['CreateProjectRequest']; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['ProjectCreatedResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove A Project * @description Remove a project associated with an organization. * Additionally, kick off background tasks to remove other projects that are not fully deleted. */ remove_a_project_v1_project_remove_post: { requestBody: { content: { 'application/json': components['schemas']['RemoveProjectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove A Index * @description Remove an index */ remove_a_index_v1_project_index_remove_post: { requestBody: { content: { 'application/json': components['schemas']['RemoveIndexRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Project Indices * @deprecated * @description Updates the indices in a project that has unindexed progressively added data */ update_project_indices_v1_project_update_indices_post: { requestBody: { content: { 'application/json': components['schemas']['UpdateProjectIndicesRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['UpdateProjectIndicesResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Data Delete * @description Deletes datums and corresponding atoms from the project. Does not reflect in project/index state until an * index update call if made (transaction commit) */ data_delete_v1_project_data_delete_post: { requestBody: { content: { 'application/json': components['schemas']['ProjectDataDeleteRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Data Update * @description Updates the requested datums. Does not reflect in project/index state until an * index update call if made (transaction commit) */ data_update_v1_project_data_update_post: { requestBody: { content: { 'application/json': components['schemas']['ProjectDataUpdateRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Data Get Arrow * @description Export data as arrow format for a project and/or index */ data_get_arrow_v1_project_data_get_arrow_post: { requestBody: { content: { 'application/json': components['schemas']['ProjectDataArrowExportRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Add Arrow * @description Add data to a project in arrow format. */ add_arrow_v1_project_data_add_arrow_post: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; }; }; /** * Add Blob * @description Add blob to S3 for usage within a map */ add_blob_v1_project_data_add_blobs_post: { requestBody: { content: { 'multipart/form-data': components['schemas']['Body_add_blob_v1_project_data_add_blobs_post']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['AddBlobResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Data Get Blob */ data_get_blob_v1_project_data_get_blob__dataset_id___blob_hash__get: { parameters: { path: { dataset_id: string; blob_hash: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['GetBlobResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Nearest Neighbors By Embedding */ nearest_neighbors_by_embedding_v1_project_data_get_nearest_neighbors_by_embedding_post: { requestBody: { content: { 'application/json': components['schemas']['EmbeddingNeighborRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['EmbeddingNeighborResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Nearest Neighbors By Ids Arrow */ nearest_neighbors_by_ids_arrow_v1_project_data_get_arrow_nearest_neighbors_by_id_post: { requestBody: { content: { 'application/json': components['schemas']['EmbeddingNeighborByIDRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Nearest Neighbors By Ids */ nearest_neighbors_by_ids_v1_project_data_get_nearest_neighbors_by_id_post: { requestBody: { content: { 'application/json': components['schemas']['EmbeddingNeighborByIDRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['EmbeddingNeighborResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Data Topic Query */ data_topic_query_v1_project_data_get_embedding_topic_post: { requestBody: { content: { 'application/json': components['schemas']['EmbeddingTopicRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Get Embedding Page Endpoint * @description Get a page of embedding data for a project */ get_embedding_page_endpoint_v1_project_data_get_embedding_paged_post: { requestBody: { content: { 'application/json': components['schemas']['PagedEmbeddingRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Datum Table * @description Get a table of datums for a map */ datum_table_v1_project_projection__map_id__datums_get: { parameters: { query: { /** * @description The IDs of the datums to fetch, in 'tile-row' format * @example [ * "13-264" * ] */ qid: string[]; /** @description The response type, either 'arrow' or 'json' */ response_type?: string; /** @description The columns to fetch */ columns?: string[]; summary?: unknown; }; path: { map_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Datums By Ids Handler */ get_datums_by_ids_handler_v1_project_data_get_post: { requestBody: { content: { 'application/json': components['schemas']['GetDatumRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['GetDatumResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Atoms Get */ atoms_get_v1_project_atoms_get_post: { requestBody: { content: { 'application/json': components['schemas']['AtomsRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['AtomsResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Create Index * @description Creates an index and returns the job id of the index creation job. */ create_index_v1_project_index_create_post: { requestBody: { content: { 'application/json': components['schemas']['CreateAtlasIndexRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['CreateAtlasIndexResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Index Job * @description Fetches an index job to the front-end. */ fetch_index_job_v1_project_index_job__job_id__get: { parameters: { path: { job_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['IndexJob']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Job Progress * @description Fetches latest job data by index id. */ fetch_job_progress_v1_project_index_job_progress__index_id__get: { parameters: { path: { index_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['JobProgressResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Job System State * @description Gets the state of the job system for a particular atlas index. */ fetch_job_system_state_v1_project_jobs_status__index_id__get: { parameters: { path: { index_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['JobSystemIndexStatusResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Quadtree Manifest */ quadtree_manifest_v1_project__project_id__index_projection__projection_id__quadtree_manifest_feather_get: { parameters: { path: { project_id: string; projection_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Quadtree Tile * @description Fetches a quadtree tile to the front-end. */ fetch_quadtree_tile_v1_project__project_id__index_projection__projection_id__quadtree__quadtree_key__get: { parameters: { path: { project_id: string; projection_id: string; quadtree_key: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Fetch Quadtree Tile With Payload */ fetch_quadtree_tile_with_payload_v1_project__project_id__index_projection__projection_id__quadtree__quadtree_key__post: { parameters: { path: { project_id: string; projection_id: string; quadtree_key: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Fetch Schema */ fetch_schema_v1_project_projection__projection_id__schema_get: { parameters: { path: { projection_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Topic Density */ topic_density_v1_project__atlas_index_id__topic_density_post: { parameters: { path: { atlas_index_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['TopicDensityRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['TopicDensityResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Map Information * @description Fetches all information about a map such as topics, defaults, etc. */ fetch_map_information_v1_project__project_id__index_projection__projection_id__get: { parameters: { path: { project_id: string; projection_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectionResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Projection Alias * @description Fetches project id and projection id from an alias. */ fetch_projection_alias_v1_project_projection_alias__projection_alias__get: { parameters: { path: { projection_alias: unknown; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectionAliasResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Projection Alias * @description Edit or add projection alias. */ update_projection_alias_v1_project_projection_alias_edit__project_id__post: { parameters: { path: { project_id: unknown; }; }; requestBody: { content: { 'application/json': components['schemas']['EditProjectionAliasRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Projection Alias By Projection Id * @description Get projection alias by projection id. */ fetch_projection_alias_by_projection_id_v1_project_projection_alias_get__project_id__post: { parameters: { path: { project_id: unknown; }; }; requestBody: { content: { 'application/json': components['schemas']['GetProjectionAliasRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['GetProjectionAliasResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Topic Model * @description Updates a topic model geojson with updates to topic position or topic label. * Currently accomplishes this by accepting an entirely new geojson and replacing * existing one. Will eventually be more granular than that. */ update_topic_model_v1_project_topics_update__topic_model_id__post: { parameters: { path: { topic_model_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['UpdateTopicModelRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Search User * @description Searches against users by nickname and email who are non in the organization of the user performing search. * This endpoint is used when attempting to invite users to an organization. */ search_user_v1_project_search_user_post: { requestBody: { content: { 'application/json': components['schemas']['SearchUserProjectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SearchUserResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Project By Slug * @description Fetches all details about a project. */ fetch_project_by_slug_v1_project__organization_slug__project__project_slug__get: { parameters: { path: { organization_slug: unknown; project_slug: unknown; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['Project']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Project By Slug * @description Fetches all details about a project. */ fetch_project_by_slug_v1_project__organization_slug___project_slug__get: { parameters: { path: { organization_slug: unknown; project_slug: unknown; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['Project']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Projection View From Hash * @description Fetches state-view variables for a projection. */ fetch_projection_view_from_hash_v1_project_projection__projection_id__view__state_hash__get: { parameters: { path: { projection_id: string; state_hash: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Create Hash * @description sets a projection state on a project */ create_hash_v1_project_projection__projection_id__view_post: { parameters: { path: { projection_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['CreateProjectionViewRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Project Id From Map Id */ get_project_id_from_map_id_v1_project_projection__map_id__get_dataset_id_get: { parameters: { query?: { summary?: unknown; }; path: { map_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Get Dataset Members * @description Fetches all dataset members */ get_dataset_members_v1_project__dataset_id__members__get: { parameters: { path: { dataset_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['DatasetMembershipWithPicture'][]; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Add Dataset Member */ add_dataset_member_v1_project__dataset_id__members_add_post: { parameters: { path: { dataset_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['DatasetMemberCreateRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove Dataset Member * @description Remove a dataset member */ remove_dataset_member_v1_project__dataset_id__members_delete_post: { parameters: { path: { dataset_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['DatasetMemberDeleteRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Dataset Member * @description Update a dataset member role */ update_dataset_member_v1_project__dataset_id__members_update_post: { parameters: { path: { dataset_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['DatasetMemberUpdateRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Tags For Project */ get_tags_for_project_v1_dataset_tags__project_id__get: { parameters: { path: { project_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Add Tag To Project */ add_tag_to_project_v1_dataset_tags__project_id__post: { parameters: { query: { /** @description The dataset tag to be added to the project */ tag: string; }; path: { project_id: string; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Delete Tag From Project */ delete_tag_from_project_v1_dataset_tags__project_id__delete: { parameters: { query: { /** @description The dataset tag to be deleted from the project */ tag: string; }; path: { project_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Project * @description Fetches all details about a project. */ fetch_project_v1_dataset__project_id__get: { parameters: { path: { project_id: unknown; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['Project']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch All Project * @deprecated * @description Fetches all project for authenticated user. */ fetch_all_project_v1_dataset_sidebar_list_get: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectsResponse']; }; }; }; }; /** * Fetch All Project * @description Fetches all project for authenticated user. */ fetch_all_project_v1_dataset__get: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectsResponse']; }; }; }; }; /** * Update Project Metadata * @description Edit project metadata. */ update_project_metadata_v1_dataset_update_post: { parameters: { query: { project_id: unknown; }; }; requestBody: { content: { 'application/json': components['schemas']['EditProjectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Project Metadata * @description Edit project metadata. */ update_project_metadata_v1_dataset_update__project_id__post: { parameters: { path: { project_id: unknown; }; }; requestBody: { content: { 'application/json': components['schemas']['EditProjectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Search Semantic */ search_semantic_v1_dataset_search_vector_post: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; }; }; /** Search Semantic Id */ search_semantic_id_v1_dataset_search_id_get: { parameters: { query: { /** @description The ID of the project. */ project_id: string; /** @description The ID of the projection. */ projection_id: string; /** @description The tiles to be used, as a JSON-encoded list. */ tiles: string; /** @description The tile index where the search embedding is located */ tix: number; /** @description The row number of the embedding in its quadtree tile */ rix: number; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Project Name Search */ project_name_search_v1_dataset_search_name_post: { requestBody: { content: { 'application/json': components['schemas']['ProjectNameSearchRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectNameSearchResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Create New Project * @description Create a project associated with an organization. */ create_new_project_v1_dataset_create_post: { requestBody: { content: { 'application/json': components['schemas']['CreateProjectRequest']; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['ProjectCreatedResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove A Project * @description Remove a project associated with an organization. * Additionally, kick off background tasks to remove other projects that are not fully deleted. */ remove_a_project_v1_dataset_remove_post: { requestBody: { content: { 'application/json': components['schemas']['RemoveProjectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove A Index * @description Remove an index */ remove_a_index_v1_dataset_index_remove_post: { requestBody: { content: { 'application/json': components['schemas']['RemoveIndexRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Project Indices * @deprecated * @description Updates the indices in a project that has unindexed progressively added data */ update_project_indices_v1_dataset_update_indices_post: { requestBody: { content: { 'application/json': components['schemas']['UpdateProjectIndicesRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['UpdateProjectIndicesResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Data Delete * @description Deletes datums and corresponding atoms from the project. Does not reflect in project/index state until an * index update call if made (transaction commit) */ data_delete_v1_dataset_data_delete_post: { requestBody: { content: { 'application/json': components['schemas']['ProjectDataDeleteRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Data Update * @description Updates the requested datums. Does not reflect in project/index state until an * index update call if made (transaction commit) */ data_update_v1_dataset_data_update_post: { requestBody: { content: { 'application/json': components['schemas']['ProjectDataUpdateRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Data Get Arrow * @description Export data as arrow format for a project and/or index */ data_get_arrow_v1_dataset_data_get_arrow_post: { requestBody: { content: { 'application/json': components['schemas']['ProjectDataArrowExportRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Add Arrow * @description Add data to a project in arrow format. */ add_arrow_v1_dataset_data_add_arrow_post: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; }; }; /** * Add Blob * @description Add blob to S3 for usage within a map */ add_blob_v1_dataset_data_add_blobs_post: { requestBody: { content: { 'multipart/form-data': components['schemas']['Body_add_blob_v1_dataset_data_add_blobs_post']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['AddBlobResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Data Get Blob */ data_get_blob_v1_dataset_data_get_blob__dataset_id___blob_hash__get: { parameters: { path: { dataset_id: string; blob_hash: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['GetBlobResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Nearest Neighbors By Embedding */ nearest_neighbors_by_embedding_v1_dataset_data_get_nearest_neighbors_by_embedding_post: { requestBody: { content: { 'application/json': components['schemas']['EmbeddingNeighborRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['EmbeddingNeighborResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Nearest Neighbors By Ids Arrow */ nearest_neighbors_by_ids_arrow_v1_dataset_data_get_arrow_nearest_neighbors_by_id_post: { requestBody: { content: { 'application/json': components['schemas']['EmbeddingNeighborByIDRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Nearest Neighbors By Ids */ nearest_neighbors_by_ids_v1_dataset_data_get_nearest_neighbors_by_id_post: { requestBody: { content: { 'application/json': components['schemas']['EmbeddingNeighborByIDRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['EmbeddingNeighborResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Data Topic Query */ data_topic_query_v1_dataset_data_get_embedding_topic_post: { requestBody: { content: { 'application/json': components['schemas']['EmbeddingTopicRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Get Embedding Page Endpoint * @description Get a page of embedding data for a project */ get_embedding_page_endpoint_v1_dataset_data_get_embedding_paged_post: { requestBody: { content: { 'application/json': components['schemas']['PagedEmbeddingRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Datum Table * @description Get a table of datums for a map */ datum_table_v1_dataset_projection__map_id__datums_get: { parameters: { query: { /** * @description The IDs of the datums to fetch, in 'tile-row' format * @example [ * "13-264" * ] */ qid: string[]; /** @description The response type, either 'arrow' or 'json' */ response_type?: string; /** @description The columns to fetch */ columns?: string[]; summary?: unknown; }; path: { map_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Datums By Ids Handler */ get_datums_by_ids_handler_v1_dataset_data_get_post: { requestBody: { content: { 'application/json': components['schemas']['GetDatumRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['GetDatumResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Atoms Get */ atoms_get_v1_dataset_atoms_get_post: { requestBody: { content: { 'application/json': components['schemas']['AtomsRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['AtomsResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Create Index * @description Creates an index and returns the job id of the index creation job. */ create_index_v1_dataset_index_create_post: { requestBody: { content: { 'application/json': components['schemas']['CreateAtlasIndexRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['CreateAtlasIndexResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Index Job * @description Fetches an index job to the front-end. */ fetch_index_job_v1_dataset_index_job__job_id__get: { parameters: { path: { job_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['IndexJob']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Job Progress * @description Fetches latest job data by index id. */ fetch_job_progress_v1_dataset_index_job_progress__index_id__get: { parameters: { path: { index_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['JobProgressResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Job System State * @description Gets the state of the job system for a particular atlas index. */ fetch_job_system_state_v1_dataset_jobs_status__index_id__get: { parameters: { path: { index_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['JobSystemIndexStatusResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Quadtree Manifest */ quadtree_manifest_v1_dataset__project_id__index_projection__projection_id__quadtree_manifest_feather_get: { parameters: { path: { project_id: string; projection_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Quadtree Tile * @description Fetches a quadtree tile to the front-end. */ fetch_quadtree_tile_v1_dataset__project_id__index_projection__projection_id__quadtree__quadtree_key__get: { parameters: { path: { project_id: string; projection_id: string; quadtree_key: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Fetch Quadtree Tile With Payload */ fetch_quadtree_tile_with_payload_v1_dataset__project_id__index_projection__projection_id__quadtree__quadtree_key__post: { parameters: { path: { project_id: string; projection_id: string; quadtree_key: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Fetch Schema */ fetch_schema_v1_dataset_projection__projection_id__schema_get: { parameters: { path: { projection_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Topic Density */ topic_density_v1_dataset__atlas_index_id__topic_density_post: { parameters: { path: { atlas_index_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['TopicDensityRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['TopicDensityResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Map Information * @description Fetches all information about a map such as topics, defaults, etc. */ fetch_map_information_v1_dataset__project_id__index_projection__projection_id__get: { parameters: { path: { project_id: string; projection_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectionResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Projection Alias * @description Fetches project id and projection id from an alias. */ fetch_projection_alias_v1_dataset_projection_alias__projection_alias__get: { parameters: { path: { projection_alias: unknown; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['ProjectionAliasResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Projection Alias * @description Edit or add projection alias. */ update_projection_alias_v1_dataset_projection_alias_edit__project_id__post: { parameters: { path: { project_id: unknown; }; }; requestBody: { content: { 'application/json': components['schemas']['EditProjectionAliasRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Projection Alias By Projection Id * @description Get projection alias by projection id. */ fetch_projection_alias_by_projection_id_v1_dataset_projection_alias_get__project_id__post: { parameters: { path: { project_id: unknown; }; }; requestBody: { content: { 'application/json': components['schemas']['GetProjectionAliasRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['GetProjectionAliasResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Topic Model * @description Updates a topic model geojson with updates to topic position or topic label. * Currently accomplishes this by accepting an entirely new geojson and replacing * existing one. Will eventually be more granular than that. */ update_topic_model_v1_dataset_topics_update__topic_model_id__post: { parameters: { path: { topic_model_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['UpdateTopicModelRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Search User * @description Searches against users by nickname and email who are non in the organization of the user performing search. * This endpoint is used when attempting to invite users to an organization. */ search_user_v1_dataset_search_user_post: { requestBody: { content: { 'application/json': components['schemas']['SearchUserProjectRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SearchUserResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Project By Slug * @description Fetches all details about a project. */ fetch_project_by_slug_v1_dataset__organization_slug__project__project_slug__get: { parameters: { path: { organization_slug: unknown; project_slug: unknown; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['Project']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Project By Slug * @description Fetches all details about a project. */ fetch_project_by_slug_v1_dataset__organization_slug___project_slug__get: { parameters: { path: { organization_slug: unknown; project_slug: unknown; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['Project']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Projection View From Hash * @description Fetches state-view variables for a projection. */ fetch_projection_view_from_hash_v1_dataset_projection__projection_id__view__state_hash__get: { parameters: { path: { projection_id: string; state_hash: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Create Hash * @description sets a projection state on a project */ create_hash_v1_dataset_projection__projection_id__view_post: { parameters: { path: { projection_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['CreateProjectionViewRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Project Id From Map Id */ get_project_id_from_map_id_v1_dataset_projection__map_id__get_dataset_id_get: { parameters: { query?: { summary?: unknown; }; path: { map_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Get Dataset Members * @description Fetches all dataset members */ get_dataset_members_v1_dataset__dataset_id__members__get: { parameters: { path: { dataset_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['DatasetMembershipWithPicture'][]; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Add Dataset Member */ add_dataset_member_v1_dataset__dataset_id__members_add_post: { parameters: { path: { dataset_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['DatasetMemberCreateRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Remove Dataset Member * @description Remove a dataset member */ remove_dataset_member_v1_dataset__dataset_id__members_delete_post: { parameters: { path: { dataset_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['DatasetMemberDeleteRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Update Dataset Member * @description Update a dataset member role */ update_dataset_member_v1_dataset__dataset_id__members_update_post: { parameters: { path: { dataset_id: string; }; }; requestBody: { content: { 'application/json': components['schemas']['DatasetMemberUpdateRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Validate Promo Code * @description Validate a promo code against a plan type using Stripe API */ validate_promo_code_v1_stripe_promo_code_validate_post: { requestBody: { content: { 'application/json': components['schemas']['ValidatePromoCodeRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Stripe Subscription * @description Create stripe subscription checkout session url and send it to front end */ stripe_subscription_v1_stripe_subscribe_post: { requestBody: { content: { 'application/json': components['schemas']['StripeSubscriptionCreateRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['StripeSubscriptionCreateResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Set Organization Billing Limits * @description Sets the organization billing limits */ set_organization_billing_limits_v1_stripe_set_organization_limits_post: { requestBody: { content: { 'application/json': components['schemas']['SetOrganizationLimitsRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SetOrganizationLimitsResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Cancel Stripe Subscription * @description Create stripe subscription checkout session url and send it to front end */ cancel_stripe_subscription_v1_stripe_cancel_post: { requestBody: { content: { 'application/json': components['schemas']['StripeSubscriptionCancelRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Webhook Received * @description Monitor stripe webhook triggered events */ webhook_received_v1_stripe_webhook_post: { responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; }; }; /** * Embed Text * @description Generates text embeddings */ embed_text_v1_embedding_text_post: { parameters: { query?: { /** @description Use semantic search mode */ semantic_search?: boolean; }; }; requestBody: { content: { 'application/json': components['schemas']['TextEmbeddingInferenceRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['TextEmbeddingInferenceResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Create Tag Request */ create_tag_request_v1_project_projection_tags_create_post: { requestBody: { content: { 'application/json': components['schemas']['TagRequest']; }; }; responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['TagResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Tag Mask Request */ tag_mask_request_v1_project_projection_tags_update_mask_post: { responses: { /** @description Successful Response */ 201: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; }; }; /** Delete Tag Request */ delete_tag_request_v1_project_projection_tags_delete_post: { requestBody: { content: { 'application/json': components['schemas']['TagWithIdRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Update Tag Request */ update_tag_request_v1_project_projection_tags_update_post: { requestBody: { content: { 'application/json': components['schemas']['UpdateTagNameRequest'] | components['schemas']['UpdateTagDefinitionRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': unknown; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Tag Request */ get_tag_request_v1_project_projection_tags_get_get: { parameters: { query: { tag_id: string; project_id?: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['TagResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Tags In Projection Request */ get_tags_in_projection_request_v1_project_projection_tags_get_all_get: { parameters: { query: { /** @description The project UUID. */ project_id: string; /** @description The projection UUID. */ projection_id: string; /** @description Whether to return the full DSL rule for all tags */ include_dsl_rule?: boolean; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['TagResponse'][]; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Get Tag Status */ get_tag_status_v1_project_projection_tags_status_get: { parameters: { query: { project_id: string; tag_id: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['TagStatus']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Tag Projection Job Request */ tag_projection_job_request_v1_project_projection_tags_robotag_post: { requestBody: { content: { 'application/json': components['schemas']['TagWithIdRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SuccessResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** Reduce Dimensionality By Embedding */ reduce_dimensionality_by_embedding_v1_reduce__post: { requestBody: { content: { 'application/json': components['schemas']['DimensionalityReductionRequest']; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['DimensionalityReductionResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; /** * Fetch Datasets By Query * @description Fetches datasets based on query parameters */ fetch_datasets_by_query_v1_search_datasets_get: { parameters: { query?: { /** @description Search term to match on project name or description */ search_term?: string; }; }; responses: { /** @description Successful Response */ 200: { content: { 'application/json': components['schemas']['SearchDatasetsResponse']; }; }; /** @description Validation Error */ 422: { content: { 'application/json': components['schemas']['HTTPValidationError']; }; }; }; }; }