[Integrations](https://spiral.ai/integrations) › [OpenClaw](https://spiral.ai/integrations/openclaw) › [Higgsfield documentation index](https://spiral.ai/integrations/openclaw/higgsfield-documentation-index)

# How to Use Higgsfield documentation index in OpenClaw

Returns the pages organized in Higgsfield's documentation index. Use it to map the available guides and references before choosing which page to read.

|  |  |
| --- | --- |
| Model | Higgsfield documentation index |
| Available through | Alexandria |
| Category | Developer |
| Price | $0.00873 per call. |
| Returns | json |
| Runs | In the background |
| Setup | About 2 minutes, no API key |

## Prompts to try with Higgsfield documentation index in OpenClaw

- Each week, use Higgsfield documentation index to identify newly listed or removed request lifecycle guides and include their links.
- Every Monday at 9am: use Higgsfield documentation index to look this up and give me the result as a table.
- Pull the latest numbers from Higgsfield documentation index and tell me what changed since last week.
- Check Higgsfield documentation index and summarize what you find in three bullet points.
- Pull the newest data from Higgsfield documentation index and give me the result as a table.

## How to set up Higgsfield documentation index in OpenClaw

Pick the way that suits you. Each takes about two minutes.

### Use the Spiral skill

1. **Send OpenClaw this message**: Your agent reads Spiral's skill and sets itself up.

```
set up https://spiral.ai/SKILL.md
```

2. **Sign in or paste a key**: Approve Spiral in the browser, or give the agent a key from the console.

### Use Spiral's MCP server

1. **Add the server**: On the machine that runs OpenClaw's Gateway:

```bash
openclaw mcp add spiral \
  --url https://api.spiral.ai/mcp \
  --transport streamable-http \
  --auth oauth
```

2. **Sign in**: In Settings › MCP, select Sign in on the Spiral server, sign in to Spiral and click Authorize. No API key.

```bash
openclaw mcp login spiral
```

3. **Reload and check**: A running Gateway may keep its old tool list: restart it, or Save & Publish in the Control UI.

```bash
openclaw mcp reload
openclaw mcp doctor spiral --probe
```

### Use the Spiral CLI

1. **Install and sign in**: Installs the Spiral CLI, signs you in and adds its skill to your coding agents.

```bash
npx -y spiral-cli@latest init
```

### Call the Spiral API

1. **Create an API key**: In the console, under API keys.

2. **Run Higgsfield documentation index**: One request; the result comes back by polling or a webhook.

```bash
curl https://api.spiral.ai/v1/runs \
  -H "Authorization: Bearer $SPIRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "provider": "alexandria",
    "model": "docs-higgsfield-ai/developer-documentation/list_pages",
    "input": {
      "q": "<q>"
    }
  }'
```

Then paste one of the prompts above: OpenClaw finds Higgsfield documentation index on Spiral, shows the price and runs it.

Setup guide in the docs: https://spiral.ai/docs/quickstarts/openclaw

## Higgsfield documentation index tools and prices

- [Higgsfield API Docs · List pages](https://spiral.ai/tools/alexandria/docs-higgsfield-ai/developer-documentation/list_pages) (Alexandria): $0.00873 per call.

## Settings you can ask for

| Setting | Allowed values | Default | Description |
| --- | --- | --- | --- |
| q |  | — | Case-insensitive text matched against title, path and description. |
| url |  | — | The index URL, https://docs.higgsfield.ai/docs/llms.txt (the root /llms.txt is accepted and read from /docs/llms.txt). Pattern: ^https?://. |
| group |  | — | Exact group heading, case-insensitive, e.g. Request lifecycle and media. |

## What can you do with Higgsfield documentation index in OpenClaw?

Maintain a change report for Higgsfield's documented models, workflows, and API guidance. A scheduled agent can compare retrieved documentation with its previous results and highlight changes that need review.

### Plan a product video feature

Compare documented video models for a product demo, inspect the chosen workflow's requirements, and collect the request lifecycle references needed for an implementation plan.

### Evaluate an image generation feature

Build a shortlist from the image catalog, inspect each candidate's workflow documentation, and identify the shared operations and guides needed for an image generation application.

### Maintain a documented capability matrix

Create a source-linked table of image and video models, workflows, endpoint paths, and documented requirements. Keep catalog coverage separate from operations found in the supplementary OpenAPI file.

### Review a model migration

Compare the documented workflows of the current model and a proposed replacement. Identify request changes, different output instructions, and shared API operations that the migration needs to preserve.

### Investigate a generation failure

Find the relevant error guidance, inspect the selected workflow's requirements, and read the documented request status operations before proposing a correction.

### Write a source-linked developer handbook

Assemble a handbook covering model selection, workflow requirements, shared API operations, and troubleshooting. Link each section to the Higgsfield page that supports it.

## Overview

- [Alexandria](https://spiral.ai/providers/alexandria)
- [All OpenClaw guides](https://spiral.ai/integrations/openclaw)

## Higgsfield documentation index in other agents

- [Amp](https://spiral.ai/integrations/amp/higgsfield-documentation-index)
- [ChatGPT](https://spiral.ai/integrations/chatgpt/higgsfield-documentation-index)
- [Claude](https://spiral.ai/integrations/claude-desktop/higgsfield-documentation-index)
- [Claude Code](https://spiral.ai/integrations/claude-code/higgsfield-documentation-index)
- [Cline](https://spiral.ai/integrations/cline/higgsfield-documentation-index)
- [Codex](https://spiral.ai/integrations/codex/higgsfield-documentation-index)
- [Cursor](https://spiral.ai/integrations/cursor/higgsfield-documentation-index)
- [Devin](https://spiral.ai/integrations/devin/higgsfield-documentation-index)
- [dots](https://spiral.ai/integrations/dots/higgsfield-documentation-index)
- [Factory Droid](https://spiral.ai/integrations/factory-droid/higgsfield-documentation-index)
- [Gemini](https://spiral.ai/integrations/gemini/higgsfield-documentation-index)
- [Gemini CLI](https://spiral.ai/integrations/gemini-cli/higgsfield-documentation-index)
- [Google Antigravity](https://spiral.ai/integrations/antigravity/higgsfield-documentation-index)
- [goose](https://spiral.ai/integrations/goose/higgsfield-documentation-index)
- [Grok](https://spiral.ai/integrations/grok/higgsfield-documentation-index)
- [Grok Build](https://spiral.ai/integrations/grok-build/higgsfield-documentation-index)
- [Hermes](https://spiral.ai/integrations/hermes/higgsfield-documentation-index)
- [Instinct](https://spiral.ai/integrations/instinct/higgsfield-documentation-index)
- [Manus](https://spiral.ai/integrations/manus/higgsfield-documentation-index)
- [Muse](https://spiral.ai/integrations/muse/higgsfield-documentation-index)
- [Muse Code](https://spiral.ai/integrations/muse-code/higgsfield-documentation-index)
- [n8n](https://spiral.ai/integrations/n8n/higgsfield-documentation-index)
- [Notion](https://spiral.ai/integrations/notion/higgsfield-documentation-index)
- [opencode](https://spiral.ai/integrations/opencode/higgsfield-documentation-index)
- [Perplexity](https://spiral.ai/integrations/perplexity/higgsfield-documentation-index)
- [Raycast](https://spiral.ai/integrations/raycast/higgsfield-documentation-index)
- [VS Code](https://spiral.ai/integrations/vscode/higgsfield-documentation-index)
- [Windsurf](https://spiral.ai/integrations/windsurf/higgsfield-documentation-index)
- [Zapier](https://spiral.ai/integrations/zapier/higgsfield-documentation-index)

## More OpenClaw guides

- [Higgsfield API endpoint reference](https://spiral.ai/integrations/openclaw/higgsfield-api-endpoint-reference)
- [Higgsfield documentation page](https://spiral.ai/integrations/openclaw/higgsfield-documentation-page)
- [Hermes Agent release notes](https://spiral.ai/integrations/openclaw/hermes-agent-release-notes)
- [Higgsfield documentation search](https://spiral.ai/integrations/openclaw/higgsfield-documentation-search)
- [Hermes Agent product overview](https://spiral.ai/integrations/openclaw/hermes-agent-product-overview)
- [Higgsfield model catalog](https://spiral.ai/integrations/openclaw/higgsfield-model-catalog)

## Questions about Higgsfield documentation index in OpenClaw

**Can OpenClaw use Higgsfield documentation index?**

Yes. Add Spiral to OpenClaw as an MCP server, and OpenClaw can find and run Higgsfield documentation index like any built-in tool.

**How much does Higgsfield documentation index cost in OpenClaw?**

$0.00873 per call. You pay from your Spiral balance as you go, with no subscription, and a failed run is not charged. Your OpenClaw plan is separate.

**Do I need an Alexandria account to use Higgsfield documentation index in OpenClaw?**

No. Spiral runs Higgsfield documentation index on its own Alexandria account. You sign in to Spiral once and never paste a key.

**How long does it take to set up Higgsfield documentation index in OpenClaw?**

About two minutes: add the server, then sign in, then reload and check.

**Does OpenClaw wait while Higgsfield documentation index runs?**

Higgsfield documentation index runs in the background. OpenClaw starts the run, checks on it and gives you the json when it's ready.

**How much of Higgsfield's model catalog is documented?**

The model reference currently lists 84 entries: 17 image entries and 67 video entries. It also identifies Soul ID as a training workflow, so catalog entries do not all represent media generation.

**Does the OpenAPI specification contain every available model?**

Higgsfield explicitly calls the OpenAPI file supplementary. A model missing from that file may still have its own documentation, so use the selected model's documentation when checking its capabilities.

**Can I reuse one workflow's schema for another?**

Higgsfield documents schemas at the workflow level, including required fields, supported values, and examples. Check the exact workflow you intend to use rather than assuming another workflow accepts the same request.

**How often does Higgsfield update its documentation?**

Higgsfield's API terms describe the API reference, changelog, and integration guides as updated from time to time. That wording does not promise a daily or weekly publication schedule.

**What source material do these documentation tools cover?**

They cover public agent-facing Higgsfield documentation, including Markdown pages, the documentation index, published OpenAPI operations, model catalogs, and workflow schemas.

