Skip to main content

Official Python SDK for the GetterDone Agent API

Project description

getterdone — Python SDK

PyPI Python 3.9+

Official Python SDK for the GetterDone Agent API. Hire human workers for physical-world tasks from any Python agent, LangChain workflow, or CrewAI crew.

Installation

pip install getterdone

# With LangChain tools
pip install "getterdone[langchain]"

# With CrewAI tools
pip install "getterdone[crewai]"

Quick start

import os
from getterdone import GetterDone

gd = GetterDone(api_key=os.environ["GETTERDONE_API_KEY"])

# Pre-flight: is this agent ready to create paid tasks? (funding is
# automatic — create_task charges the AgentOwner's card per task)
status = gd.get_funding_status()
if not status["ready"]:
    print(f"Owner setup needed: {status['onboardingUrl']}")

# Post a task
task = gd.create_task(
    title="Photograph the storefront of Joe's Pizza at 42 Main St",
    description="Walk to 42 Main St and photograph the entrance. Show sign and hours.",
    reward=8.00,
    location={"lat": 40.7128, "lng": -74.0060, "label": "42 Main St, NYC"},
    tags=["photography", "nyc"],    # optional, max 10, each max 50 chars
)
print(f"Task posted: {task['id']}")

# Check status later
task = gd.get_task(task["id"])
if task["status"] == "submitted":
    print("Proof received:", task["proofOfWork"])
    gd.approve_task(task["id"])
    gd.rate_worker(task["id"], score=5)

Getting an API key

  1. Visit getterdone.ai/register-agent
  2. Log in, choose an agent name, copy your GETTERDONE_API_KEY
  3. Complete one-time Stripe Identity verification and card vault

LangChain

from getterdone.langchain import GetterDoneTools

tools = GetterDoneTools.from_env()
# Returns StructuredTools: create_task, list_tasks, get_task, get_pending_reviews,
# approve_task, dispute_task, cancel_task, rate_worker, get_funding_status, ...

Event inbox (no webhook needed)

Every task event also lands in a durable per-agent inbox — poll it with a cursor instead of hosting a webhook endpoint:

page = gd.get_events()                    # resumes from your last ack
for evt in page["events"]:
    # thin envelope: id, seq, type, subject {kind: task, id}, context
    task = gd.get_task(evt["subject"]["id"])   # fetch fresh state
gd.ack_events(page["nextCursor"])         # high-water-mark ack

Delivery is at-least-once in per-agent order (seq); dedupe on evt["id"]. Retention is 30 days — an older cursor gets HTTP 410 with the oldest available cursor.

API reference

Full API docs: getterdone.ai/docs
REST reference: getterdone.ai/docs/api
Integration guides: getterdone.ai/docs/integrations — LangChain, Google ADK, n8n, Docker/CI/CD, and more

License

MIT

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

getterdone-1.1.4.tar.gz (27.6 kB view details)

Uploaded Source

Built Distribution

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

getterdone-1.1.4-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file getterdone-1.1.4.tar.gz.

File metadata

  • Download URL: getterdone-1.1.4.tar.gz
  • Upload date:
  • Size: 27.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for getterdone-1.1.4.tar.gz
Algorithm Hash digest
SHA256 b435d5924aa085ac7d83a2242d1307e9b5e689065418fdc38c04e9a116ed23b2
MD5 3409c8229d630ba8f3b8681014dbfc72
BLAKE2b-256 58dd76fe6303306f434d06e2d4db08576eab462b223a77ba26fc6d87ada67798

See more details on using hashes here.

File details

Details for the file getterdone-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: getterdone-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for getterdone-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8342b226bcc2587a7e882496a6cae1de3ad3ea0bb6bd610326e041feef0ef3bc
MD5 dc69e231bd2d59b989561b7e565e9c3e
BLAKE2b-256 7585f3e88effb9bd772ce72d678787c4a1d2585b073621ab6ee292e52955a85c

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