Skip to main content

Python SDK for the AIR Backend API

Project description

AIR SDK

Python SDK for the AIR Backend API.

Installation

pip install air-sdk

Quick Start

import air

client = air.AIR(api_key="air_k1_...", base_url="http://localhost:8000")

# Standalone tools
keywords = client.keywords("dark matter and lensing", n=5, kw_type="aas")
enhanced = client.enhance("My research with https://arxiv.org/abs/2301.12345")

# Full research workflow
project = client.create_project("my-research", data_description="We study...")
idea = project.idea()
project.literature()
project.methods()
project.paper(journal="AAS")
review = project.review()

# File access
print(project.get_file("Iteration0/input_files/idea.md"))
print(project.list_files())

Configuration

Set AIR_API_KEY and optionally AIR_BASE_URL as environment variables, or pass them directly:

client = air.AIR(api_key="air_k1_...", base_url="https://api.example.com")

API Reference

AIR class

Method Description
keywords(text, n=5, kw_type="unesco") Extract keywords
arxiv(text) Download arXiv papers from URLs in text
enhance(text, max_workers=2, max_depth=10) Enhance text with arXiv context
ocr(file_path) Process PDF with OCR (server path)
create_project(name, data_description, iteration) Create a project
get_project(name) Get existing project
list_projects() List all projects
delete_project(name) Delete a project

Project class

Method Description
idea(mode="fast", timeout=600) Generate research idea
literature(timeout=600) Run literature search
methods(mode="fast", timeout=600) Develop methods
paper(journal="NONE", timeout=900) Write paper
review(timeout=600) Run review
get_file(path) Read a project file
list_files() List all project files
write_file(path, content) Write a file
delete() Delete the project

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

ai_research-0.1.4.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

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

ai_research-0.1.4-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file ai_research-0.1.4.tar.gz.

File metadata

  • Download URL: ai_research-0.1.4.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ai_research-0.1.4.tar.gz
Algorithm Hash digest
SHA256 aab9828c1cc0c7d42aa9f137aa45332d8cd3e20b2c269d5957272dbbf86796c1
MD5 3da3229ee68e3a32b686cc62df6dd963
BLAKE2b-256 cd8419edac89f3fef47000a9c5dd72b1e00260bb25666fe943b2e92c977d970a

See more details on using hashes here.

File details

Details for the file ai_research-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ai_research-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ai_research-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8a9f6bf36f8523c3ddbc4cb1326679ff09f7ff74f6ed3d765bc51335438de1d1
MD5 e1b82a2dd1bc4739b53bdad784d28abc
BLAKE2b-256 3a62476840118df25b45da9b457fe29f29d603780605a15f009ed914f9e194ce

See more details on using hashes here.

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