Skip to main content

Agent Quickstart

Use this page when an AI agent needs to understand Elfa quickly, choose the right surface, and avoid scraping docs page by page.

Load Context First

Agents should load the high-signal sources before walking individual docs pages:

  1. Read llms.txt for the docs map and canonical machine-readable links.
  2. Read the raw Elfa Agent Skill directly when the environment cannot install skills.
  3. When skills are available, install or refresh with npx skills add elfa-ai/skills.
  4. Use the Endpoint manifest or OpenAPI for exact request/response metadata.
  5. Use llms-full.txt only when deeper page context is needed.

Refresh the Elfa skill weekly so agents pick up the latest Auto capabilities and integration guidance as they ship.

Choose the Right Surface

If the agent needs to...Start withWhy
Ask a market question or summarize current contextMarket Intelligence ChatFastest path to written interpretation without building a retrieval pipeline.
Discover attention, accounts, tokens, news, or narrativesMarket IntelligenceOn-demand structured signals and source-backed context.
Chain market data calls into a workflowMarket Intelligence Agent PlaybooksEndpoint chains for lead discovery, influence vetting, cause analysis, and evidence gathering.
Watch continuously and fire when conditions resolve trueAutoManaged condition engine, trigger pipeline, delivery actions, and optional LLM/trade actions.
Build an Auto plan end-to-endAuto Agent QuickstartDeterministic validate -> create -> stream/poll flow for agents.
Continue work after an Auto triggerAuto Agent RunnerWorker pattern for policy, queueing, replay, and follow-up decisions.
Build a custom UI on Elfa's runtimeWidget Headless QuickstartServer-to-server widget surface with end-user identity, sessions, quotas, and personalization.
Pay per request without provisioning an API keyx402 PaymentsWallet-native access for autonomous agents.

Agent Boot Sequence

  1. Load the skill or raw skill file.
  2. Read llms.txt.
  3. Pick the product surface from the table above.
  4. Use the endpoint manifest or REST reference for exact method, path, auth, cost, and examples.
  5. Validate requests before mutation where the product supports validation.
  6. Prefer product-specific quickstarts for execution order and error handling.

Access Model Routing

ModelBest whenDocs
API keyYou want account-linked usage, plan limits, and monthly or PAYG credits.Authentication
API key + HMACYou mutate Auto state, connect exchanges, or create trade-action plans.Auto API Key + HMAC
x402The agent has a wallet and should pay per request without an API key.x402 Payments
x402 AutoThe agent should create, poll, and manage Auto plans with wallet-based payment.Auto x402 Instructions
Widget keyA partner backend calls Elfa for many end-users under its own UI.Widget Headless Quickstart

Runtime Data Rules

For Auto runtime data, distinguish:

  • latestEvaluation.conditionStates[]: latest current-state values.
  • Auto Trigger Context on executions (triggerTime, conditionsMet, trigger): what fired.
  • trigger.matchedConditions[].match.observedValue: value observed at trigger time.

For Market Intelligence data, remember:

  • Measurement endpoints return counts, links, and account/token metadata.
  • Interpretation endpoints return written analysis or summaries.
  • Measurement endpoints do not return raw tweet text or sentiment fields.