Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Orq MCP is live: Use natural language to interrogate traces, spot regressions, and experiment your way to optimal AI configurations. Available in Claude Desktop, Claude Code, Cursor, and more. Start now →
SDK reference for the Projects API, available in Node.js and Python.
starting_after or ending_before to page through large collections.
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)
Show Parameters
{
"limit": Optional[int],
"starting_after": Optional[str],
"ending_before": Optional[str],
}
Show Response
{
"object": str,
"data": {
"project_id": str,
"name": str,
"key": str,
"is_archived": bool,
"is_default": bool,
"teams": List[str],
"created_at": date,
"updated_at": date,
"created_by_id": Optional[str],
"updated_by_id": Optional[str],
"description": Optional[str],
},
"has_more": bool,
}
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.projects.create(name="<value>")
# Handle response
print(res)
Show Parameters
{
"name": str, # required
"teams": List[str],
"description": Optional[str],
}
Show Response
{
"project": {
"project_id": str,
"name": str,
"key": str,
"is_archived": bool,
"is_default": bool,
"teams": List[str],
"created_at": date,
"updated_at": date,
"created_by_id": Optional[str],
"updated_by_id": Optional[str],
"description": Optional[str],
},
}
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)
Show Parameters
{
"project_id": str, # required
}
Show Response
{
"project": {
"project_id": str,
"name": str,
"key": str,
"is_archived": bool,
"is_default": bool,
"teams": List[str],
"created_at": date,
"updated_at": date,
"created_by_id": Optional[str],
"updated_by_id": Optional[str],
"description": Optional[str],
},
}
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)
Show Parameters
{
"project_id": str, # required
}
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="<value>")
# Handle response
print(res)
Show Parameters
{
"project_id": str, # required
"name": Optional[str],
"teams": List[str],
"description": Optional[str],
}
Show Response
{
"project": {
"project_id": str,
"name": str,
"key": str,
"is_archived": bool,
"is_default": bool,
"teams": List[str],
"created_at": date,
"updated_at": date,
"created_by_id": Optional[str],
"updated_by_id": Optional[str],
"description": Optional[str],
},
}
Was this page helpful?