Skills
List Skills
Returns the skills visible to the current workspace, ordered by creation time with the newest skill first. Usestarting_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.skills.list()
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.skills.list();
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"limit": Optional[int],
"starting_after": Optional[str],
"ending_before": Optional[str],
}
{
limit?: number;
startingAfter?: string;
endingBefore?: string;
}
Show Response
Show Response
{
"object": str,
"data": [{
"skill_id": str,
"display_name": str,
"description": str,
"tags": List[str],
"project_id": str,
"path": str,
"created_at": str,
"updated_at": str,
"created_by_id": str,
"updated_by_id": str,
"instructions": str,
"version": str,
}],
"has_more": bool,
}
{
object: string;
data: {
skillId: string;
displayName: string;
description: string;
tags: string[];
projectId: string;
path: string;
createdAt: Date;
updatedAt: Date;
createdById: string;
updatedById: string;
instructions: string;
version: string;
}[];
hasMore: boolean;
}
Create a Skill
Creates a reusable skill in the workspace. Skills store instructions, metadata, and an optional project location so teams can standardize repeatable AI workflows.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY"),
) as orq:
res = orq.skills.create(request={
"display_name": "summarize_thread",
"project_id": "<id>",
})
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.skills.create({
displayName: "summarize_thread",
projectId: "<id>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
# one of: CreateSkillRequest1, CreateSkillRequest2
"display_name": str, # required
"description": Optional[str],
"tags": List[str], # optional
"path": Union[str, Optional[str]], # required (variant-specific)
"project_id": Union[Optional[str], str], # required (variant-specific)
"instructions": Optional[str],
}
{
// one of: CreateSkillRequest1, CreateSkillRequest2
displayName: string; // required
description?: string;
tags?: string[];
path: string; // required (variant-specific)
projectId: string; // required (variant-specific)
instructions?: string;
}
Show Response
Show Response
{
"skill": {
"skill_id": str,
"display_name": str,
"description": str,
"tags": List[str],
"project_id": str,
"path": str,
"created_at": str,
"updated_at": str,
"created_by_id": str,
"updated_by_id": str,
"instructions": str,
"version": str,
},
}
{
skill: {
skillId: string;
displayName: string;
description: string;
tags: string[];
projectId: string;
path: string;
createdAt: Date;
updatedAt: Date;
createdById: string;
updatedById: string;
instructions: string;
version: string;
};
}
Retrieve a Skill
Retrieves an existing skill by skill ID. Display names are also accepted for compatibility because they are unique within a workspace.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY"),
) as orq:
res = orq.skills.get(skill_id="<id>")
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.skills.get({
skillId: "<id>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"skill_id": str, # required
}
{
skillId: string; // required
}
Show Response
Show Response
{
"skill": {
"skill_id": str,
"display_name": str,
"description": str,
"tags": List[str],
"project_id": str,
"path": str,
"created_at": str,
"updated_at": str,
"created_by_id": str,
"updated_by_id": str,
"instructions": str,
"version": str,
},
}
{
skill: {
skillId: string;
displayName: string;
description: string;
tags: string[];
projectId: string;
path: string;
createdAt: Date;
updatedAt: Date;
createdById: string;
updatedById: string;
instructions: string;
version: string;
};
}
Delete a Skill
Deletes a skill from the workspace. The response body is empty when the delete succeeds.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY"),
) as orq:
res = orq.skills.delete(skill_id="<id>")
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.skills.delete({
skillId: "<id>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"skill_id": str, # required
}
{
skillId: string; // required
}
Update a Skill
Updates mutable skill fields. Omitted fields keep their current values. Whentags is provided it replaces the existing tags; send an empty array to clear them.
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY"),
) as orq:
res = orq.skills.update(skill_id="<value>", display_name="<value>")
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.skills.update({
skillId: "<id>",
updateSkillRequest: {
displayName: "<value>",
},
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"skill_id": str, # required
"display_name": Optional[str],
"description": Optional[str],
"tags": List[str], # optional
"path": Optional[str],
"instructions": Optional[str],
"project_id": Optional[str],
}
{
skillId: string; // required
updateSkillRequest: { // required
displayName?: string;
description?: string;
tags?: string[];
path?: string;
instructions?: string;
projectId?: string;
};
}
Show Response
Show Response
{
"skill": {
"skill_id": str,
"display_name": str,
"description": str,
"tags": List[str],
"project_id": str,
"path": str,
"created_at": str,
"updated_at": str,
"created_by_id": str,
"updated_by_id": str,
"instructions": str,
"version": str,
},
}
{
skill: {
skillId: string;
displayName: string;
description: string;
tags: string[];
projectId: string;
path: string;
createdAt: Date;
updatedAt: Date;
createdById: string;
updatedById: string;
instructions: string;
version: string;
};
}