SDK

FlyPix's interactive API docs include ready-to-copy code snippets in a wide range of languages for every endpoint, generated straight from the live spec. For most languages, that's the fastest way to get going: open the endpoint you need and copy the snippet for your language of choice.

FlyPix also publishes an official Python SDK, and the underlying OpenAPI spec is open for you to generate a full client in any other language yourself.

Official SDK: Python

Published on PyPI as flypix, generated from FlyPix's v2 API and open source on GitHub at flypixai/flypix-sdk.

warning

Every release targets the current v2 API. If you're on a version published before v2's rasters-not-files change, update immediately — that version calls operations that no longer exist. See the migration guide for details.

Installing

pip install flypix
# or
uv add flypix
# or
poetry add flypix

Basic usage

from flypix import Flypix, models

with Flypix(
    security=models.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
) as client:
    tenants = client.users.list_tenants()
    print(tenants)

Pass the same API key you'd use in the ApiKey header on a raw HTTP request — see Authentication for how to create one. An async client is available too:

import asyncio
from flypix import Flypix, models

async def main():
    async with Flypix(
        security=models.Security(api_key="<YOUR_API_KEY_HERE>"),
    ) as client:
        tenants = await client.users.list_tenants_async()
        print(tenants)

asyncio.run(main())

For a full walkthrough — uploading a file, applying a model, and reading back results — see examples/quickstart.py in the repository.

Response models are typed with Pydantic — the v2 migration's file_id → raster_id renames on vectors, regions, inferences, and model application show up as attribute changes on those models, alongside the matching client.rasters.* methods.

This SDK's own version number doesn't track the API's version — it follows its own semantic versioning based on what changed in the client itself. Check the GitHub releases page for what changed in a given release, rather than assuming an SDK version lines up with an API version.

Other languages

There's no official SDK for languages other than Python yet. If you need one:

• Copy the snippets for your language directly from the interactive API docs — each endpoint there includes examples for a wide range of languages, kept in sync with the live API.
• Or download the OpenAPI spec from the same docs and run it through a generator such as OpenAPI Generator to produce a full typed client in the language of your choice.