Skip to content

project

Bases: BaseProject

Source code in airia/client/project/sync_project.py 
10
11
def __init__(self, request_handler: RequestHandler):
    super().__init__(request_handler)

get_project(project_id, correlation_id=None)

Retrieve detailed information for a specific project.

This method fetches comprehensive information about a single project, including all associated resources, metadata, and configuration details.

Parameters:

Name Type Description Default
project_id str

The unique identifier (GUID) of the project to retrieve.

 required
correlation_id str

A unique identifier for request tracing and logging. If not provided, one will be automatically generated.

 None

Returns:

Name Type Description
ProjectItem ProjectItem

A ProjectItem object containing complete project information including pipelines, models, data sources, and metadata.

Raises:

Type Description
AiriaAPIError

If the API request fails, including cases where: - Project not found (404) - Authentication fails (401) - Access is forbidden (403) - Server errors (5xx)
Example 
from airia import AiriaClient

client = AiriaClient(api_key="your_api_key")

# Get a specific project by ID
project = client.project.get_project("12345678-1234-1234-1234-123456789abc")

print(f"Project: {project.name}")
print(f"Description: {project.description}")
print(f"Pipelines: {len(project.pipelines)}")
print(f"Created: {project.created_at}")
Note

The project must be accessible to the authenticated user. Users will only be able to retrieve projects they have been granted access to.

Source code in airia/client/project/sync_project.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def get_project(
    self, project_id: str, correlation_id: Optional[str] = None
) -> ProjectItem:
    """
    Retrieve detailed information for a specific project.

    This method fetches comprehensive information about a single project,
    including all associated resources, metadata, and configuration details.

    Args:
        project_id (str): The unique identifier (GUID) of the project to retrieve.
        correlation_id (str, optional): A unique identifier for request tracing
            and logging. If not provided, one will be automatically generated.

    Returns:
        ProjectItem: A ProjectItem object containing complete project
            information including pipelines, models, data sources, and metadata.

    Raises:
        AiriaAPIError: If the API request fails, including cases where:
            - Project not found (404)
            - Authentication fails (401)
            - Access is forbidden (403)
            - Server errors (5xx)

    Example:
        ```python
        from airia import AiriaClient

        client = AiriaClient(api_key="your_api_key")

        # Get a specific project by ID
        project = client.project.get_project("12345678-1234-1234-1234-123456789abc")

        print(f"Project: {project.name}")
        print(f"Description: {project.description}")
        print(f"Pipelines: {len(project.pipelines)}")
        print(f"Created: {project.created_at}")
        ```

    Note:
        The project must be accessible to the authenticated user.
        Users will only be able to retrieve projects they have been granted
        access to.
    """
    request_data = self._pre_get_project(
        project_id=project_id,
        correlation_id=correlation_id,
        api_version=ApiVersion.V1.value,
    )
    resp = self._request_handler.make_request("GET", request_data)

    return ProjectItem(**resp)

get_projects(correlation_id=None)

Retrieve a list of all projects accessible to the authenticated user.

This method fetches comprehensive information about all projects that the current user has access to, including project metadata, creation details, and status information.

Parameters:

Name Type Description Default
correlation_id str

A unique identifier for request tracing and logging. If not provided, one will be automatically generated.

 None

Returns:

Type Description
List[ProjectItem]

List[ProjectItem]: A list of ProjectItem objects containing project information. Returns an empty list if no projects are accessible or found.

Raises:

Type Description
AiriaAPIError

If the API request fails, including cases where: - Authentication fails (401) - Access is forbidden (403) - Server errors (5xx)
Example 
from airia import AiriaClient

client = AiriaClient(api_key="your_api_key")

# Get all accessible projects
projects = client.project.get_projects()

for project in projects:
    print(f"Project: {project.name}")
    print(f"ID: {project.id}")
    print(f"Description: {project.description}")
    print(f"Created: {project.created_at}")
    print("---")
Note

The returned projects are filtered based on the authenticated user's permissions. Users will only see projects they have been granted access to.

Source code in airia/client/project/sync_project.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def get_projects(self, correlation_id: Optional[str] = None) -> List[ProjectItem]:
    """
    Retrieve a list of all projects accessible to the authenticated user.

    This method fetches comprehensive information about all projects that the
    current user has access to, including project metadata, creation details,
    and status information.

    Args:
        correlation_id (str, optional): A unique identifier for request tracing
            and logging. If not provided, one will be automatically generated.

    Returns:
        List[ProjectItem]: A list of ProjectItem objects containing project
            information. Returns an empty list if no projects are accessible
            or found.

    Raises:
        AiriaAPIError: If the API request fails, including cases where:
            - Authentication fails (401)
            - Access is forbidden (403)
            - Server errors (5xx)

    Example:
        ```python
        from airia import AiriaClient

        client = AiriaClient(api_key="your_api_key")

        # Get all accessible projects
        projects = client.project.get_projects()

        for project in projects:
            print(f"Project: {project.name}")
            print(f"ID: {project.id}")
            print(f"Description: {project.description}")
            print(f"Created: {project.created_at}")
            print("---")
        ```

    Note:
        The returned projects are filtered based on the authenticated user's
        permissions. Users will only see projects they have been granted
        access to.
    """
    request_data = self._pre_get_projects(
        correlation_id=correlation_id, api_version=ApiVersion.V1.value
    )
    resp = self._request_handler.make_request("GET", request_data)

    if "items" not in resp or len(resp["items"]) == 0:
        return []

    return [ProjectItem(**item) for item in resp["items"]]