Skip to main content

​
Projects

​
List Projects

Returns a list of projects. Projects are sorted by creation date, with the most recently created projects appearing first. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.projects.list()

    # Handle response
    print(res)

​
Create a Project

Creates a new project within the workspace. Projects organize resources like skills, deployments, and datasets. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.projects.create()

    # Handle response
    print(res)

​
Retrieve a Project

Retrieves the details of an existing project by its unique project ID. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.projects.get(project_id="<id>")

    # Handle response
    print(res)

​
Delete a Project

Delete a project 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.projects.delete(project_id="<id>")

    # Handle response
    print(res)

​
Update a Project

Updates the specified project by setting the values of the parameters passed. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.projects.update(project_id_param="<value>")

    # Handle response
    print(res)