Skip to main content
This guide introduces the Lit Chipotle API and its web interface, the Lit Chipotle Dashboard which allows both web3 and non-web3 developers to quickly set up their Lit environment and start using Lit Actions.

​
Zero to LitAction

  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 LitAction
    1. From the Dashboard
    2. Programmatically via cURL/JavaScript
    3. or build your own SDK from the OpenAPI spec

​
Overview

The Lit Chipotle Dashboard is the front end to the Lit Chipotle API server, designed to quickly and efficiently execute Lit Actions and to manage your user accounts, usage parameters, client wallet creation (PKPs), and IPFS based actions, through a simple set of groups.

Specifically it lets you:
  • Create accounts and obtain a master account API key.
  • Create usage API keys that can be scoped to specific lit-actions or used by dApps.
  • Create and manage wallets (PKPs) for signing and on-chain operations.
  • Register IPFS CIDs (immutable actions) and scope which wallets have access to them.
  • Organize all your resources into groups that combine PKPs, IPFS actions, and usage API keys in any combination.
  • Send lit-actions to the node for execution, authorized by a usage or account API key.
All of this can be done via the Dashboard (web GUI) or directly via the REST API, using a light-weight JS SDK, or even directly through cURL commands. Data is secure and on-chain—all configuration within the Dashboard can be achieved by talking directly to our contracts located on BASE.

​
Using the Dashboard

The Dashboard is a web management GUI for Lit’s Chipotle offering. Open it from your browser at https://dashboard.dev.litprotocol.com/dapps/dashboard/ It supports light/dark theme for your convenience and provides simple management tools. Dashboard workflow (recommended order):
  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 detailed step-by-step instructions with screenshots, see Using the Dashboard.

​
Using the API directly

The same workflows can be done via the REST API under /core/v1/. All endpoints that require authentication expect the API key in a header (X-Api-Key or Authorization: Bearer). API 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 to your liking, you can simply call the lit-action endpoint with your usage key each time you, your dApp or cron job needs to execute a lit action. So the only daily use step is
  1. Call the API with your usage key, action-code ( or IPFS CID ) and any parameters that you need

​
Further Reading