Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.herodotus.cloud/llms.txt

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

Have a look at the Atlantic API AI Skill to give your LLM a head start on using the Atlantic API. For programmatic API-key acquisition without the GUI, see the Herodotus Auth AI Skill and Programmatic wallet authentication.

​
Sign in with GitHub

  1. Navigate to https://www.herodotus.cloud/
  2. Click ‘Start with Github’ and Authorize ‘HerodotusDev’
  3. Once authorized, you will be redirected to the dashboard.

​
Obtain your API Key

  1. In the sidebar, click on ‘API KEYS’.
  2. Click on ‘Copy’ next to your API key or generate a new one.
Keep this key secure as it grants you access to performing queries

​
Use the HCloud SDK or CLI

For scripts, agents, and backend services, prefer the HCloud SDK or CLI before writing a custom Atlantic client. The package handles API-key resolution, programmatic wallet authentication, query submission, polling helpers, artifact access, and Atlantic x402 payment retries. See the package on npm: https://www.npmjs.com/package/@herodotus_dev/hcloud. Install the SDK: 
npm install @herodotus_dev/hcloud
Install the CLI: 
npm install -g @herodotus_dev/hcloud
Submit a query with the CLI: 
HCLOUD_API_KEY=... hcloud atlantic submit-query --pie-file ./pie.zip --declared-job-size S
Or authenticate once with an EVM wallet and let HCloud store credentials under ~/.hcloud: 
WALLET_PRIVATE_KEY=0x... hcloud auth login
hcloud atlantic submit-query --pie-file ./pie.zip --declared-job-size S
Use the SDK from TypeScript: 
import { HcloudClient, submitAndWait } from '@herodotus_dev/hcloud';

const client = new HcloudClient({
  apiKey: process.env.HCLOUD_API_KEY,
});

const result = await submitAndWait(client.atlantic, {
  declaredJobSize: 'S',
  pieFile: './pie.zip',
});

console.log(result.atlanticQuery.id, result.atlanticQuery.status);

​
Apply for credits

Before sending any queries, you need to apply for credits at https://herodotus.dev/contact-us

​
Authentication step by step