Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.adaline.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

ProjectsClient

adaline.projects lists and manages the projects in your workspace. Every method is async.

Access

from adaline.main import Adaline

adaline = Adaline()
projects = adaline.projects  # ProjectsClient
The class is also exported directly:
from adaline.clients import ProjectsClient
Types from adaline_api:
from adaline_api.models.project import Project
from adaline_api.models.update_project_request import UpdateProjectRequest
from adaline_api.models.list_projects_response import ListProjectsResponse

list()

List all projects the API key has access to.
async def list() -> ListProjectsResponse

Returns

ListProjectsResponse with { data: list[Project] }.

Example

response = await adaline.projects.list()

for project in response.data:
    print(project.id, project.title)

get()

Get a single project by ID.
async def get(*, project_id: str) -> Project

Parameters

NameTypeRequiredDescription
project_idstrYesProject identifier.

Example

project = await adaline.projects.get(project_id="project_abc123")
print(project.title, project.icon)

update()

Update a project’s title and/or icon. At least one field must be provided.
async def update(
    *,
    project_id: str,
    project: UpdateProjectRequest,
) -> Project

Parameters

NameTypeRequiredDescription
project_idstrYesProject identifier.
projectUpdateProjectRequestYesFields to update (title?, icon?).

Example

from adaline_api.models.update_project_request import UpdateProjectRequest

updated = await adaline.projects.update(
    project_id="project_abc123",
    project=UpdateProjectRequest(
        title="Renamed project",
        icon={"type": "emoji", "value": "✨"},
    ),
)

See Also