SDK Reference

Every task receives an aisle object injected at runtime. No imports needed — it's just there.

# The full SDK is available as `aisle` inside any task script
result = aisle.ai.prompt("Summarize this")
aisle.create_chat("Summary ready", result)

The reference below covers every method and module. Click any method to expand its parameter details.

Root Methods

Called directly on the aisle object.

aisle.create_chat()→ dict | None▸

Create a chat output message for this task run.

aisle.output()→ None▸

Set the definitive return value for this task run.

aisle.log()→ None▸

Append a message to the task run log.

aisle.sleep()→ None▸

Pause execution for the given number of seconds (max 900).

aisle.parallel()→ ParallelResult▸

Run fn(item) for each item using a producer-consumer pool.

Modules

Namespaced tools accessed via aisle.<module>.

`aisle.ai`

AI tools — prompt, run_prompt, and provider-native web/search tools.

aisle.ai.prompt()→ str | dict▸

Call an LLM with the given instruction.

aisle.ai.run_prompt()→ str▸

Run a saved prompt by UUID (positional) or human-readable slug (keyword).

aisle.ai.anthropic_web_search()→ list▸

Search the web using Anthropic's built-in search tool.

aisle.ai.anthropic_web_fetch()→ str▸

Fetch and extract the text content of a URL using Anthropic.

aisle.ai.openai_web_search()→ list▸

Search the web using OpenAI's built-in search tool.

aisle.ai.gemini_google_search()→ list▸

Search Google using Gemini's grounding tool.

aisle.ai.gemini_url_context()→ str▸

Fetch and summarise one or more URLs using Gemini URL context.

aisle.ai.xai_x_search()→ list▸

Search X (Twitter) using xAI's live search tool.

`aisle.memories`

Memory operations — search, store, get, update, query, list, propositions.

aisle.memories.search()→ list▸

Keyword search over memory records. Returns a list of matching records.

aisle.memories.get()→ dict▸

Fetch a single memory record by name.

aisle.memories.store()→ dict▸

Create a memory record.

aisle.memories.archive()→ dict▸

Mark a memory as archived. Idempotent — archiving an

aisle.memories.unarchive()→ dict▸

Restore an archived memory to active status. Idempotent.

aisle.memories.await_embedding()→ dict▸

Block until the memory's embeddings finish (or fail).

aisle.memories.vector_search()→ list▸

Semantic search returning [{id, name, content, similarity}].

aisle.memories.update()→ dict▸

Update an existing memory record by ID.

aisle.memories.query()→ list▸

Filter records by name or metadata key-value pairs.

aisle.memories.list_all()→ list▸

List all memory records (lightweight: id, name, created_at).

aisle.memories.get_propositions()→ list▸

Get semantic proposition chunks for a record.

`aisle.http`

HTTP tool — outbound requests proxied through Elixir for URL validation.

aisle.http.request()→ dict▸

Make an HTTP request. Returns {status, headers, body}.

`aisle.files`

Files tool — write, read, metadata, split, and convert operations.

aisle.files.write()→ dict▸

Write content as a named file. Returns an aisle_input_file blob.

aisle.files.begin_upload()→ dict▸

Request a presigned S3 upload URL for a large file.

aisle.files.complete_upload()→ dict▸

Confirm a large file upload and get the aisle_input_file blob.

aisle.files.read()→ any▸

Read a file's contents by reference.

aisle.files.download_url()→ str▸

Return a presigned S3 URL for the file (8 hour expiry).

aisle.files.metadata()→ dict▸

Return file metadata. With include_url=True, also includes a

aisle.files.split_pdf()→ list▸

Split a PDF into individual pages.

aisle.files.convert()→ dict▸

Convert a file to a simpler format.

`aisle.inputs`

Inputs accessor — read-only view over merged trigger + user inputs.

aisle.inputs.get()→ Any▸

Return the value for input param `name`, or `default` if absent.

aisle.inputs.all()→ dict

Return all input params as a dict.

`aisle.integrations`

Integration proxy — routes provider.mode() calls to Elixir via RPC plus provider.connect() for direct-connect providers.

`aisle.checkpoint`

aisle.checkpoint — run-scoped key/value store (DynamoDB-backed, no RPC).

aisle.checkpoint.done()→ bool▸

Return True if this key has been marked or set.

aisle.checkpoint.mark()→ any▸

Record completion with no stored value.

aisle.checkpoint.get()→ Optional[Any]▸

Return stored value, or None if absent or mark-only.

aisle.checkpoint.set()→ any▸

Store a JSON-serializable value (also marks as done).

aisle.checkpoint.get_or_set()→ Any▸

Return cached value if present; otherwise call fn(), store, and return.

`aisle.cache`

aisle.cache — task-scoped key/value store with required TTL.

aisle.cache.get()→ Optional[Any]▸

Return stored value if present and not expired, else None.

aisle.cache.set()→ any▸

Store value with TTL. ttl: int seconds or '1h'/'1d' string.

aisle.cache.get_or_set()→ Any▸

Return cached value if present; otherwise call fn(), store, and return.

aisle.cache.delete()→ any▸

Explicitly evict a cached value.

`aisle.run`

aisle.run — runtime metadata for the current task invocation.

Properties

Property	Type	Description
`execution_id`	`str`	Unique id for this run; correlate against logs and execution records.
`task_id`	`str \| None`	The AutomatedTask id this run belongs to; None for unsaved test runs.
`is_test`	`bool`	True when invoked as an unsaved draft from the task editor.
`started_at`	`datetime`	UTC timestamp of when this run was enqueued (tz-aware).
`last_run_at`	`datetime \| None`	UTC timestamp of the previous successful run; None on first run.
`user`	`dict \| None`	{"id": uuid} of the human who pressed Run; None for schedule/webhook/system.
`creator`	`dict \| None`	{"id": uuid} of the task author; the authorization subject for credentials and memory.
`company`	`dict \| None`	{"id": uuid} of the company this task runs under; None when unscoped.
`project`	`dict \| None`	{"id": uuid} of the project bound to this task; None when standalone.

`aisle.dates`

aisle.dates — date and datetime utilities for task scripts.

aisle.dates.today()→ date▸

Return today's UTC date.

aisle.dates.now()→ datetime

Return the current UTC datetime (tz-aware).

aisle.dates.parse()→ datetime▸

Parse a value into a tz-aware UTC datetime.

Integration Providers

Connected via aisle.integrations.<provider>.<method>(). Click a provider to expand its methods.

Affinityaisle.integrations.affinity4 methods▸

Integrate with the Affinity CRM API

Ahrefsaisle.integrations.ahrefs8 methods▸

SEO data: backlinks, organic keywords, domain metrics, and keyword research

Airtableaisle.integrations.airtable11 methods▸

Integrate with the Airtable API

Asanaaisle.integrations.asana20 methods▸

Project management and task tracking

Fathomaisle.integrations.fathom3 methods▸

AI meeting recorder with transcripts, summaries, and action items

Fireflies.aiaisle.integrations.fireflies8 methods▸

AI-powered meeting transcription and analysis

GitHubaisle.integrations.github8 methods▸

Interact with GitHub repositories and pull requests

Gmailaisle.integrations.gmail17 methods▸

Watch emails and manage Gmail operations

Gong.ioaisle.integrations.gong2 methods▸

Fetch call transcripts and detailed call/CRM data from Gong

Google Driveaisle.integrations.google-drive10 methods▸

Manage folders and files in Google Drive

Google Mapsaisle.integrations.google-maps6 methods▸

Location, geocoding, places, and routing via Google Maps APIs

JIRAaisle.integrations.jira5 methods▸

Integrate with the JIRA API

Microsoft OneDriveaisle.integrations.microsoft_onedrive19 methods▸

Microsoft's cloud file storage for Microsoft 365. Upload, download, and manage Word documents, Excel workbooks, and any file type. Read and write Excel cells, ranges, and tables. Create documents from text content.

Microsoft Teamsaisle.integrations.microsoft_teams8 methods▸

Microsoft's collaboration and messaging platform. Send messages to channels and chats, create channels, read message history, and reply to conversations. Reference teams and channels by name or ID.

Mixpanelaisle.integrations.mixpanel12 methods▸

Integrate with Mixpanel Analytics

Azure SQLaisle.integrations.mssql1 methods▸

Connect to Microsoft Azure SQL Server and execute SQL queries

Microsoft Outlook Mailaisle.integrations.outlook_mail14 methods▸

Manage Microsoft Outlook Mail messages and attachments via Microsoft Graph API

Pipedriveaisle.integrations.pipedrive14 methods▸

Integrate with the Pipedrive CRM API

PostgreSQLaisle.integrations.postgres1 methods▸

Connect to PostgreSQL databases and execute SQL queries

Redditaisle.integrations.reddit10 methods▸

Extract content from Reddit posts, subreddits, users, and search

Slackaisle.integrations.slack11 methods▸

Integrate with the Slack API

Supabaseaisle.integrations.supabase14 methods▸

Integrate with the Supabase Management API

Telegramaisle.integrations.telegram17 methods▸

Cloud messaging platform for automated notifications, group communication, and bot interactions

Xeroaisle.integrations.xero21 methods▸

Integrate with the Xero accounting API