facesign-sdk

A Python client for the FaceSign API.

Asynchronous (built on httpx) and typed (ships py.typed).

Requirements

• Python 3.12+
• httpx, pydantic (installed automatically)

Installation

pip install facesign-sdk

Authentication

The SDK resolves your API key via Credentials.default(), which checks, in order:

1. The FACESIGN_API_KEY environment variable
2. ~/.config/facesign/$FACESIGN_PROJECT/api_key

The base URL is resolved from the FACESIGN_API_URL environment variable or ~/.config/facesign/$FACESIGN_PROJECT/config.json (api_url), defaulting to https://api.facesign.ai. Pass it explicitly to the client below.

Quickstart

import asyncio
from facesign_sdk.client import Client, ClientOptions
from facesign_sdk.credentials import Credentials


async def main() -> None:
    client = Client(
        ClientOptions(
            creds=Credentials.default(),
            base_url="https://api.facesign.ai",
        )
    )

    result = await client.list_users()
    if result.status_code == 200 and result.data is not None:
        print(result.data)
    else:
        print(result.error or result.response_body)


asyncio.run(main())

Every method returns a ClientResponse[TData, TError] with:

• status_code: int
• data: TData | None — the parsed response body on success
• error: TError | None — a parsed ErrorResponse on failure
• response_body: str | None — the raw response body

Available methods

Request/response models are available in facesign_sdk.client (e.g. from facesign_sdk.client import ListUsersResponse).

Development

This package is generated from the OpenAPI spec via uni. To regenerate the client, run make gen from the repository root (it writes to facesign_sdk/client.py).

To build a distribution locally:

python -m build        # produces dist/*.whl and dist/*.tar.gz