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

goose · Developer

How to Use Higgsfield documentation search in goose

Returns matching Higgsfield documentation passages with source links and section references. Use it to locate guidance about a model or integration problem before reading the relevant page.

Prompts to try with Higgsfield documentation search in goose

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

Use Higgsfield documentation search to find guidance on generation errors and retries, then compare it with our retry logic and explain any proposed fixes.

Higgsfield documentation searchgoose
Try asking
  • Use Higgsfield documentation search to look this up and give me the result as a table. Save the result in ./assets.

  • Pull the latest numbers from Higgsfield documentation search and tell me what changed since last week.

  • Check Higgsfield documentation search and summarize what you find in three bullet points.

  • Pull the newest data from Higgsfield documentation search and give me the result as a table.

How to set up Higgsfield documentation search in goose

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

Use Spiral's MCP server

  1. Add the extension

    In goose Desktop, open the sidebar, click Extensions, then Add custom extension. Enter:

  2. Sign in

    When goose first connects to Spiral, your browser opens. Sign in to Spiral, pick the organization and click Authorize. No API key. If the browser does not open, goose prints the link to open yourself.

Use the Spiral skill

  1. Send goose 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 search

    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/search_docs",
        "input": {
          "query": "<query>"
        }
      }'

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

Higgsfield documentation search providers and prices

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

AlexandriaDeveloper
Higgsfield API Docs · Search docs
docs-higgsfield-ai/developer-documentation/search_docs

Settings you can ask for

Ask goose for any of these in your prompt.

SettingAllowed valuesDefaultDescription
Limit1 to 10

Maximum hits, 1-10 (the server returns at most 10). Defaults to 10.

Max snippet chars100 to 20000

Cut each snippet to this many characters. Defaults to 1500.

Every API field of Higgsfield API Docs · Search docs is on its tool page: open its card above.

What can you do with Higgsfield documentation search in goose?

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 search in goose

Can goose use Higgsfield documentation search?

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

How much does Higgsfield documentation search cost in goose?

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

Do I need an Alexandria account to use Higgsfield documentation search in goose?

No. Spiral runs Higgsfield documentation search 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 search in goose?

About two minutes: add the extension, then sign in.

Does goose wait while Higgsfield documentation search runs?

Higgsfield documentation search runs in the background. goose 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 search in goose

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

Paste this into goose:

Set up goose

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