Skills SDK Reference - Orq.ai Documentation

Skills

List Skills

Returns the skills visible to the current workspace, ordered by creation time with the newest skill first. Use 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.skills.list()

    # Handle response
    print(res)

Show Parameters

{
    "limit": Optional[int],
    "starting_after": Optional[str],
    "ending_before": Optional[str],
}

Show Response

{
    "object": str,
    "data": {
        "skill_id": str,
        "display_name": str,
        "description": str,
        "tags": List[str],
        "project_id": str,
        "path": str,
        "created_at": date,
        "updated_at": date,
        "created_by_id": str,
        "updated_by_id": str,
        "instructions": str,
        "version": str,
    },
    "has_more": bool,
}

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(display_name="Josefina_Conn")

    # Handle response
    print(res)

Show Parameters

{
    "display_name": str,  # required
    "description": Optional[str],
    "tags": List[str],
    "path": Optional[str],
    "project_id": Optional[str],
    "instructions": Optional[str],
}

Show Response

{
    "skill": {
        "skill_id": str,
        "display_name": str,
        "description": str,
        "tags": List[str],
        "project_id": str,
        "path": str,
        "created_at": date,
        "updated_at": date,
        "created_by_id": str,
        "updated_by_id": str,
        "instructions": str,
        "version": str,
    },
}

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)

Show Parameters

{
    "skill_id": str,  # required
}

Show Response

{
    "skill": {
        "skill_id": str,
        "display_name": str,
        "description": str,
        "tags": List[str],
        "project_id": str,
        "path": str,
        "created_at": date,
        "updated_at": date,
        "created_by_id": str,
        "updated_by_id": str,
        "instructions": str,
        "version": str,
    },
}

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)

Show Parameters

{
    "skill_id": str,  # required
}

Update a Skill

Updates mutable skill fields. Omitted optional fields keep their current values. Repeated fields such as tags replace the existing collection when provided.

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>")

    # Handle response
    print(res)

Show Parameters

{
    "skill_id": str,  # required
    "display_name": Optional[str],
    "description": Optional[str],
    "tags": List[str],
    "path": Optional[str],
    "instructions": Optional[str],
    "project_id": Optional[str],
}

Show Response

{
    "skill": {
        "skill_id": str,
        "display_name": str,
        "description": str,
        "tags": List[str],
        "project_id": str,
        "path": str,
        "created_at": date,
        "updated_at": date,
        "created_by_id": str,
        "updated_by_id": str,
        "instructions": str,
        "version": str,
    },
}

​Skills

​List Skills

​Create a Skill

​Retrieve a Skill

​Delete a Skill

​Update a Skill

Skills

List Skills

Create a Skill

Retrieve a Skill

Delete a Skill

Update a Skill