Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.litprotocol.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through creating an account, funding it, and running your first Lit Action. You can do everything from the Dashboard (web GUI) or directly against the REST API.

​
Zero to Lit Action

  1. Create an account via the Dashboard, note down your API key
  2. Add funds — click Add Funds in the Dashboard and pay with a credit card (minimum $5.00). Running Lit Actions and metered/write management operations consume credits, while read-only management calls (for example listing resources or checking your balance) are free.
  3. Add a usage API key — set its permissions by clicking All Options
  4. Run a Lit Action
    1. From the Dashboard
    2. Programmatically via cURL/JavaScript
    3. or build your own SDK from the OpenAPI spec

​
Using the Dashboard

The Dashboard is a web management GUI for Lit. It supports light/dark themes and provides simple tools for managing accounts, keys, wallets, and actions. Recommended workflow:
  1. Request a new account (or log in)
  2. Add funds via credit card
  3. Request usage API keys
  4. Request new PKPs (wallets)
  5. Register IPFS CIDs (actions)
  6. Create groups
  7. Run lit-actions
For step-by-step instructions with screenshots, see Using the Dashboard.

​
Using the API directly

The same workflows are available via the REST API under /core/v1/. All authenticated endpoints expect the API key in a header (X-Api-Key or Authorization: Bearer). Workflow:
  1. New account or verify account (login)
  2. Add funds via credit card (or via the billing API)
  3. Add usage API key
  4. Create wallet (PKP)
  5. Add group and register IPFS action
  6. Add PKP to group (optional)
  7. Run lit-action
For full code examples (JavaScript Core SDK and cURL), see the API Reference.

​
Daily Usage

The Dashboard is just your human-friendly configuration tool. Once your account and keys are set up, you can call the lit-action endpoint with your usage key every time you, your dApp, or a cron job needs to execute an action:
  1. Call the API with your usage key, action code (or IPFS CID), and any parameters you need.

​
Next steps