Overview Use Cases Connectors Authentication Getting Started with the Python SDK API API Reference ai_agents ai_chat algorithm annotations application_connectors batch_prediction code_completion custom_loss_function custom_metric database_connectors dataset deployment deployment_conversations docstore document_retrievers documentation eda external_app feature_drift feature_group feature_group_row_process feature_group_template file_connectors graph_dashboard holdout_analysis llm_apps mcp_server_connections model model_monitoring module natural_language_explanation organization pipelines predict prediction_operator project addFeatureGroupToProject addProjectTags createProject deleteProject describeProject describeUseCaseRequirements getProjectFeatureGroupConfig getRawDataFromRealtimeDataset listProjects listProjectsDashboard listUseCases removeFeatureGroupFromProject removeProjectTags renameProject setFeatureGroupType setFeatureMapping setProjectFeatureGroupConfig validateProject project_scopes python_function refresh routellm secrets streaming streaming_connectors upload user webhooks API Classes API Inputs Documentation Chat Bot API Search How to

Method

describeProject GET

Copy GET

Returns a description of a project.

Arguments:

REQUIRED	KEY	TYPE	DESCRIPTION
Yes	projectId	str	A unique string identifier for the project.

Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY

TYPE

DESCRIPTION

success

Boolean

true if the call succeeded, false if there was an error

result

Project

KEY	TYPE	Description
projectId	str	The ID of the project.
name	str	The name of the project.
useCase	str	The use case associated with the project.
problemType	str	The problem type associated with the project.
createdAt	str	The date and time when the project was created.
tags	List[str]	List of tags associated with the project.

Exceptions:

TYPE	WHEN
DataNotFoundError	`projectId` is not found.

Language: