Skip to content

Project

The Project API allows you to manage and retrieve information about your Airia projects. See the Project API reference and response types for more details.

Get Projects

You can retrieve information about your projects using the get_projects method:

from airia import AiriaClient

client = AiriaClient(api_key="your_api_key")

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

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

Get Project

You can retrieve detailed information about a specific project using the get_project method:

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"Project Type: {project.project_type}")
print(f"Created: {project.created_at}")
print(f"Updated: {project.updated_at}")

# Display associated pipelines
if project.pipelines:
    print(f"\nPipelines ({len(project.pipelines)}):")
    for pipeline in project.pipelines:
        print(f"- {pipeline.name} (ID: {pipeline.id})")

# Display budget information
if project.budget_amount:
    print(f"\nBudget: ${project.budget_amount}")
    if project.used_budget_amount:
        print(f"Used: ${project.used_budget_amount}")
    if project.budget_alert:
        print(f"Alert threshold: {project.budget_alert}%")