Spiral gives your agent every tool with one account. Browse the tools →

VS Code · Developer

How to Use Higgsfield documentation index in VS Code

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

Prompts to try with Higgsfield documentation index in VS Code

Copy an example into VS Code, or ask in your own words.

Use Higgsfield documentation index to look this up and give me the result as a table. Save the result in ./assets.

Higgsfield documentation indexVS Code
Try asking
  • 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.

  • Check Higgsfield documentation index every morning and tell me only when something changed.

How to set up Higgsfield documentation index in VS Code

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

Use Spiral's MCP server

  1. Add the hosted server

    Use Add to VS Code on the console's Agents & MCP page, or run:

    code --add-mcp '{"name":"spiral","type":"http","url":"https://api.spiral.ai/mcp"}'
  2. Sign in

    VS Code asks you to sign in when it first starts the server: sign in to Spiral and click Authorize. No API key. Run MCP: List Servers from the Command Palette to check that Spiral is running.

Use the Spiral skill

  1. Send VS Code 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 the Spiral CLI

  1. Install and sign in

    Installs the Spiral CLI, signs you in and adds its skill to your coding agents.

    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.

    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: VS Code finds Higgsfield documentation index on Spiral, shows the price and runs it.

Higgsfield documentation index providers and prices

Spiral runs Higgsfield documentation index through Alexandria. Open a card for today's price, with every fee included.

AlexandriaDeveloper
Higgsfield API Docs · List pages
docs-higgsfield-ai/developer-documentation/list_pages

What can you do with Higgsfield documentation index in VS Code?

Produce a Higgsfield implementation review with source links for model choices, workflow requirements, and request controls. A coding agent can compare that documentation with the project's generation code and propose specific changes.

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.

Questions about Higgsfield documentation index in VS Code

Can VS Code use Higgsfield documentation index?

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

How much does Higgsfield documentation index cost in VS Code?

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

Do I need an Alexandria account to use Higgsfield documentation index in VS Code?

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 VS Code?

About two minutes: add the hosted server, then sign in.

Does VS Code wait while Higgsfield documentation index runs?

Higgsfield documentation index runs in the background. VS Code 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.

Get started

Start using Higgsfield documentation index in VS Code

One Spiral account for every tool your agent needs. No subscription; you pay per run.

Paste this into VS Code:

Set up VS Code

set up https://spiral.ai/SKILL.md
Are you an AI agent? See setup options