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.5.tar.gz (27.7 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.5-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: getterdone-1.1.5.tar.gz
  • Upload date:
  • Size: 27.7 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.5.tar.gz
Algorithm Hash digest
SHA256 70784a6fc68ffdb8792a21f7921da1e72af94f91ad9499eef95d9d0eb98b9c89
MD5 8e8b12cbb30e9ed34c600921f8ef4d23
BLAKE2b-256 32961ec2b362a54aec9eba7437c56dc07a1357460c23558a1132f2da6de246f9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: getterdone-1.1.5-py3-none-any.whl
  • Upload date:
  • Size: 18.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cd5ffb4d51223a5e0af6229acbc42158f4caa045555f0339b883be1c8d6706f1
MD5 ca62455f1579da0bee36e3600e42b368
BLAKE2b-256 7daa7b6fd9bc1d764d28a1a9e2934a2df17716d027f5add4ff92af40de60d78c

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