Get Project#

Get project details from the NeMo Entity Store.

Prerequisites#

  • Access to the NeMo Entity Store service

  • The base URL of the NeMo Entity Store service stored in the environment variable ENTITY_STORE_BASE_URL

To Get a Project#

Choose one of the following options of getting a project.

Set up a NeMoMicroservices client instance using the base URL of the NeMo Entity Store microservice and perform the task as follows.

from nemo_microservices import NeMoMicroservices

client = NeMoMicroservices(
    base_url=os.environ["ENTITY_STORE_BASE_URL"]
)

response = client.projects.retrieve(
    namespace="your-namespace", # Namespace that you create using NeMo Entity Store
    project_name="your-project-name",
)
print(response)

Make a GET request to the /v1/projects/{namespace}/{name} endpoint.

export ENTITY_STORE_BASE_URL=<URL for NeMo Entity Store>
export NAMESPACE="your-namespace" # Namespace that you create using NeMo Entity Store
export PROJECT_NAME="your-project-name"

curl -X GET "${ENTITY_STORE_BASE_URL}/v1/projects/${NAMESPACE}/${PROJECT_NAME}" \
    -H 'Accept: application/json'
Example Response
{
  "id": "string",
  "created_at": "2025-06-17T02:52:14.722Z",
  "updated_at": "2025-06-17T02:52:14.722Z",
  "description": "string",
  "project": "string",
  "custom_fields": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "ownership": {
    "created_by": "",
    "access_policies": {}
  }
}