invinite-api

Typed Python client for the Invinite Web API — the workspace REST API at api.invinite.com. It is generated from the same endpoint registry that powers the REST API and the inv CLI, so its request and response models always match the reference.

The client is built on urllib3 + pydantic and imports as invinite_api.

The generated surface includes the curated team activity stream and its full-fidelity per-entity history, plus alert fire-history time ranges, per-alert events, and summary counts.

Install

pip install invinite-api

Authentication

Create a Configuration with your invw_ Web API token as the access token. The client sends it as an Authorization: Bearer <token> header on every request.

import invinite_api

config = invinite_api.Configuration(access_token=token)

Team-scoped endpoints take the team as a per-method x_team_id argument — not a global default header.

Quickstart

Configure the client, call users/me to discover your team id, then make a team-scoped list call.

import invinite_api
from invinite_api import WorkspaceApi, CompaniesListsApi

config = invinite_api.Configuration(access_token=token)

with invinite_api.ApiClient(config) as client:
    # 1. Find the team to operate on.
    me = WorkspaceApi(client).users_me()
    team_id = me.data.teams[0].id

    # 2. Make a team-scoped list call.
    lists = CompaniesListsApi(client).company_lists_list(x_team_id=team_id, limit=50)

    for company_list in lists.data.items:
        print(company_list)

Pagination

List methods return data.items plus data.next_cursor. Pass the cursor back on the next call until it is None.

api = CompaniesListsApi(client)
cursor = None
while True:
    page = api.company_lists_list(x_team_id=team_id, limit=50, cursor=cursor)
    for company_list in page.data.items:
        pass  # process company_list ...
    cursor = page.data.next_cursor
    if cursor is None:
        break

Error handling

On a non-2xx response the client raises ApiException (with per-status subclasses). Inspect error.status and parse the standard { "ok": false, "error": ..., "code": ... } envelope from error.body:

import json
from invinite_api.exceptions import ApiException

try:
    CompaniesListsApi(client).company_lists_list(x_team_id=team_id)
except ApiException as error:
    body = json.loads(error.body)  # { "ok": false, "error": ..., "code": ... }
    print(error.status, body["code"], body["error"])

Regeneration

This client is a generated artifact. If an endpoint's types look wrong, the fix belongs in the endpoint registry rather than in hand-written client code — regenerating re-derives every model from the schema. Releases are published on sdk-v* tags.

Links

• Web API docs
• Repository