[Integrations](https://spiral.ai/integrations) › [Zapier](https://spiral.ai/integrations/zapier) › [Higgsfield model documentation](https://spiral.ai/integrations/zapier/higgsfield-model-documentation)

# How to Use Higgsfield model documentation in Zapier

Returns a model's documented workflows, endpoint paths, usage notes, and request schemas. Use it to check one model's requirements before writing or reviewing generation code.

|  |  |
| --- | --- |
| Model | Higgsfield model documentation |
| 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 model documentation in Zapier

- Each week, use Higgsfield model documentation to check Kling 2.5 Turbo's Pro text to video workflow and report changes to its documented requirements or usage notes.
- Every Monday at 9am: use Higgsfield model documentation to look this up and give me the result as a table.
- Pull the latest numbers from Higgsfield model documentation and tell me what changed since last week.
- Check Higgsfield model documentation and summarize what you find in three bullet points.
- Pull the newest data from Higgsfield model documentation and give me the result as a table.

## How to set up Higgsfield model documentation in Zapier

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

### Use the Spiral skill

1. **Send Zapier 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 an MCP Client connection**: In Zapier open Apps, click Add connection and search for MCP Client. Fill in the form:

```text
https://api.spiral.ai/mcp
```

2. **Sign in to Spiral and approve**: Spiral opens: sign in, pick the organization and click Authorize. No API key. Spiral gives the connection its own key; Zapier never sees it, and you can remove it under Settings › Connected apps in the console.

3. **Run a Spiral tool in a Zap**: Add an MCP Client step to a Zap and choose the Run Tool action with your Spiral connection. Pick a tool: `discover` finds the right model for a task, `estimate_cost` prices it and `run` runs it. For example, `run` with:

```json
{
  "provider": "fal",
  "model": "fal-ai/flux/schnell",
  "input": { "prompt": "a lighthouse at dawn" },
  "wait": true
}
```

4. **Run Higgsfield model documentation in a workflow step**: Give the step an instruction like the ones below and run it on your trigger or schedule. Spiral finds Higgsfield model documentation, prices it and runs it each time the step fires.

### 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 model documentation**: 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/get_model",
    "input": {
      "model": "<model>"
    }
  }'
```

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

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

## Higgsfield model documentation tools and prices

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

## Settings you can ask for

| Setting | Allowed values | Default | Description |
| --- | --- | --- | --- |
| workflow |  | — | Workflow slug from the family's workflows, e.g. pro-text-to-video. |

## What can you do with Higgsfield model documentation in Zapier?

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.

### Check request validation code

Compare an application's validation rules with the selected workflow's documented schema and examples. Use the operation reference to distinguish generation requests from shared request controls.

### 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 Zapier guides](https://spiral.ai/integrations/zapier)

## Higgsfield model documentation in other agents

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

## More Zapier guides

- [Higgsfield model catalog](https://spiral.ai/integrations/zapier/higgsfield-model-catalog)
- [Hugging Face dataset details](https://spiral.ai/integrations/zapier/hugging-face-dataset-details)
- [Higgsfield documentation search](https://spiral.ai/integrations/zapier/higgsfield-documentation-search)
- [Hugging Face dataset search](https://spiral.ai/integrations/zapier/hugging-face-dataset-search)
- [Higgsfield documentation page](https://spiral.ai/integrations/zapier/higgsfield-documentation-page)
- [Hugging Face model details](https://spiral.ai/integrations/zapier/hugging-face-model-details)

## Questions about Higgsfield model documentation in Zapier

**Can Zapier use Higgsfield model documentation?**

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

**How much does Higgsfield model documentation cost in Zapier?**

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

**Do I need an Alexandria account to use Higgsfield model documentation in Zapier?**

No. Spiral runs Higgsfield model documentation 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 model documentation in Zapier?**

About two minutes: add an MCP Client connection, then sign in to Spiral and approve, then run a Spiral tool in a Zap.

**Does Zapier wait while Higgsfield model documentation runs?**

Higgsfield model documentation runs in the background. Zapier 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.

