Skip to main content

Official Python SDK and CLI for the Starnus AI platform

Project description

Starnus Python SDK

PyPI version Python 3.9+ License: MIT Documentation

The official Python SDK for the Starnus AI platform.

Run AI-powered agentic tasks, stream live results over WebSocket, manage projects, upload files, export artifacts, and more — all from Python or the command line.


Installation

pip install starnus

Quickstart

import starnus

client = starnus.Starnus(api_key="sk_live_your_api_key")

# Create a project
project = client.projects.create(name="Lead Research")

# Run an AI task and stream results live
execution = client.execute(
    project_id=project.id,
    prompt="Find 10 CEOs of software companies in the Netherlands.",
)

for event in execution.stream():
    if event.type == "supervisor_update":
        print(f"[supervisor] {event.message}")
    elif event.type == "result":
        print(f"\nDone: {event.message}")
        break

Authentication

Set your API key as an environment variable:

export STARNUS_API_KEY="sk_live_your_api_key"

Or pass it directly to the client:

client = starnus.Starnus(api_key="sk_live_your_api_key")

Get your API key from the Starnus dashboard under Dev Tools → API Keys.

Documentation

starnus.com/docs/

Full SDK and API reference hosted on the Starnus website. Includes:

  • All resource methods with parameters and return types
  • WebSocket streaming event reference
  • File upload, artifact export, and trigger examples
  • CLI reference
  • Error handling guide
  • API reference with live Swagger UI

Resources

Resource Description
client.projects Create and manage projects
client.execute() Run AI tasks with live streaming
client.files Upload and download files
client.artifacts Export structured AI outputs (xlsx, csv, json)
client.threads View execution history
client.tasks Manage to-do items
client.integrations Connect external services (Gmail, LinkedIn, etc.)
client.triggers Schedule recurring AI tasks
client.billing Manage plans and credits
client.api_keys Manage API keys

CLI

# Authenticate
starnus auth login

# Run a task
starnus run --project <project_id> "Find 10 fintech leads in Germany"

# List artifacts
starnus artifacts list --project <project_id>

# Export an artifact
starnus artifacts export <artifact_id> --format xlsx --output leads.xlsx

License

MIT — see LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starnus-1.0.1.tar.gz (36.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

starnus-1.0.1-py3-none-any.whl (54.4 kB view details)

Uploaded Python 3

File details

Details for the file starnus-1.0.1.tar.gz.

File metadata

  • Download URL: starnus-1.0.1.tar.gz
  • Upload date:
  • Size: 36.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for starnus-1.0.1.tar.gz
Algorithm Hash digest
SHA256 cd1ef1434df58769b5227a8071ec5d1437669a6f80617bf013ea751db29617fd
MD5 c10ccec1477bea7a48d4b6b7518270bc
BLAKE2b-256 2ff98d5163b50b3cf8cc83a0785b6b6ac57486f59e29b7799f4d15e45f5cbaee

See more details on using hashes here.

Provenance

The following attestation bundles were made for starnus-1.0.1.tar.gz:

Publisher: publish.yml on Starnus/starnus-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file starnus-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: starnus-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 54.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for starnus-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7e88b5babe186a0e9b41955a619d059ef0af966e0165a1402787090c2b6f1667
MD5 c52b09d90382f50de0fbf59de2699bc3
BLAKE2b-256 a9bc446949ee7e290ecb93f3a5e7ddbb60e37549215eba5c70c46f73ce77e8bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for starnus-1.0.1-py3-none-any.whl:

Publisher: publish.yml on Starnus/starnus-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page