Identities SDK Reference - Orq.ai Documentation

Identities

List Identities

Retrieves a paginated list of identities in your workspace. Use pagination parameters to navigate through large identity lists efficiently.

from orq_ai_sdk import Orq
import os

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

    res = orq.identities.list(limit=10, search="john", include_metrics=False)

    # Handle response
    print(res)

Show Parameters

{
    "limit": Optional[int],
    "starting_after": Optional[str],
    "ending_before": Optional[str],
    "search": Optional[str],
    "filter_by_tags": List[str],
    "include_metrics": Optional[bool],
    "sort_by": Optional[Literal["IDENTITY_SORT_FIELD_UNSPECIFIED", "IDENTITY_SORT_FIELD_DISPLAY_NAME", "IDENTITY_SORT_FIELD_UPDATED"]],
}

Show Response

{
    "object": str,
    "data": {
        "id": str,
        "external_id": str,
        "workspace_id": str,
        "display_name": Optional[str],
        "email": Optional[str],
        "avatar_url": Optional[str],
        "tags": List[str],
        "metadata": {},  # optional
        "created": str,
        "updated": str,
        "metrics": {  # optional
            "total_tokens": float,
            "total_cost": float,
            "total_requests": float,
            "error_rate": float,
        },
    },
    "has_more": bool,
}

Create an Identity

Creates a new identity with a unique external_id. If an identity with the same external_id already exists, the operation will fail.

from orq_ai_sdk import Orq
import os

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

    res = orq.identities.create(external_id="<id>")

    # Handle response
    print(res)

Show Parameters

{
    "external_id": str,  # required
    "display_name": Optional[str],
    "email": Optional[str],
    "avatar_url": Optional[str],
    "tags": List[str],
    "metadata": {},  # optional
}

Show Response

{
    "identity": {
        "id": str,
        "external_id": str,
        "workspace_id": str,
        "display_name": Optional[str],
        "email": Optional[str],
        "avatar_url": Optional[str],
        "tags": List[str],
        "metadata": {},  # optional
        "created": str,
        "updated": str,
        "metrics": {  # optional
            "total_tokens": float,
            "total_cost": float,
            "total_requests": float,
            "error_rate": float,
        },
    },
}

Retrieve an Identity

Retrieves detailed information about a specific identity using their identity ID or external ID from your system.

from orq_ai_sdk import Orq
import os

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

    res = orq.identities.retrieve(id="<id>", include_metrics=False)

    # Handle response
    print(res)

Show Parameters

{
    "id": str,  # required
    "include_metrics": Optional[bool],
}

Show Response

{
    "identity": {
        "id": str,
        "external_id": str,
        "workspace_id": str,
        "display_name": Optional[str],
        "email": Optional[str],
        "avatar_url": Optional[str],
        "tags": List[str],
        "metadata": {},  # optional
        "created": str,
        "updated": str,
        "metrics": {  # optional
            "total_tokens": float,
            "total_cost": float,
            "total_requests": float,
            "error_rate": float,
        },
    },
}

Delete an Identity

Permanently deletes an identity from your workspace and cleans up associated budget configurations.

from orq_ai_sdk import Orq
import os

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

    res = orq.identities.delete(id="<id>")

    # Handle response
    print(res)

Show Parameters

{
    "id": str,  # required
}

Update an Identity

Updates specific fields of an existing identity. Only the fields provided in the request body will be updated.

from orq_ai_sdk import Orq
import os

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

    res = orq.identities.update(id="<id>")

    # Handle response
    print(res)

Show Parameters

{
    "id": str,  # required
    "display_name": Optional[str],
    "email": Optional[str],
    "avatar_url": Optional[str],
    "tags": List[str],
    "metadata": {},  # optional
}

Show Response

{
    "identity": {
        "id": str,
        "external_id": str,
        "workspace_id": str,
        "display_name": Optional[str],
        "email": Optional[str],
        "avatar_url": Optional[str],
        "tags": List[str],
        "metadata": {},  # optional
        "created": str,
        "updated": str,
        "metrics": {  # optional
            "total_tokens": float,
            "total_cost": float,
            "total_requests": float,
            "error_rate": float,
        },
    },
}

​Identities

​List Identities

​Create an Identity

​Retrieve an Identity

​Delete an Identity

​Update an Identity

Identities

List Identities

Create an Identity

Retrieve an Identity

Delete an Identity

Update an Identity