---
type: "firecrawl-provider"
description: "Official Higgsfield API documentation from docs.higgsfield.ai: search through Higgsfield's public Mintlify docs MCP server, any page as clean Markdown with an outline and section reads, the llms.txt page index, the published OpenAPI operations, the image and video model catalog, and each model's workflows with endpoint, endpoint ID, usage notes and the full request JSON Schema. Public agent-facing sources only; no login or key. Plan prices and credit costs (higgsfield.ai) are not covered."
use_when: "Official Higgsfield API documentation from docs.higgsfield.ai: search through Higgsfield's public Mintlify docs MCP server, any page as clean Markdown with an outline and section reads, the llms.txt page index, the published OpenAPI operations, the image and video model catalog, and each model's workflows with endpoint, endpoint ID, usage notes and the full request JSON Schema. Public agent-facing sources only; no login or key. Plan prices and credit costs (higgsfield.ai) are not covered."
categories: "Developer"
capabilities: 6
credits_per_call: 5
---
# Higgsfield API Docs on Firecrawl Alexandria

Official Higgsfield API documentation from docs.higgsfield.ai: search through Higgsfield's public Mintlify docs MCP server, any page as clean Markdown with an outline and section reads, the llms.txt page index, the published OpenAPI operations, the image and video model catalog, and each model's workflows with endpoint, endpoint ID, usage notes and the full request JSON Schema. Public agent-facing sources only; no login or key. Plan prices and credit costs (higgsfield.ai) are not covered.

- Categories: Developer
- Category index: [Developer category](https://firecrawl.dev/alexandria/agents/categories/developer)
- Provider key: `docs-higgsfield-ai`
- Access: Firecrawl credits
- Cost: 5 credits per call

## More

- [Human guide](https://firecrawl.dev/app/alexandria/docs-higgsfield-ai)
- [OpenAPI spec](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/openapi.json)

## Capabilities

- [Get model](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/get_model): One Higgsfield API model family (GET /docs/models/{model}.md): name, description and every workflow with its method and API endpoint. With workflow (or a model/workflow path) it also reads that workflow page and returns the full submission URL, endpoint ID, Playground link, usage notes, top-level and required parameters, and the complete request JSON Schema. Unknown models and workflows are not_found.
- [Get page](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/get_page): One Higgsfield API docs page as clean Markdown (GET /docs/{path}.md, the docs' agent-facing rendering) with title, description, an outline of headings with anchors, and the content. section (heading text or anchor, case-insensitive) returns only that heading and its subsections. Accepts a page path or any docs.higgsfield.ai URL (the site root and /docs map to the overview page, .md URLs are accepted); an anchor in the URL selects that section. Unknown pages and sections are not_found.
- [List endpoints](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/list_endpoints): The operations in Higgsfield's published OpenAPI specification (GET /docs/openapi.json): method, path, operation ID, summary, description, tags, parameters, request-body flag and response codes, plus the spec title, version and servers. Higgsfield marks this file as supplementary: it covers the shared request status and cancel endpoints and a few model endpoints, while get_model has every model workflow. Filter by tag or text.
- [List models](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/list_models): The Higgsfield API model catalog: every image and video model family from the docs catalog pages (GET /docs/models/video-generation.md and image-generation.md) with slug, name, category, vendor, workflow count and description, plus the counts each catalog page states. Filter by category, vendor or a text query.
- [List pages](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/list_pages): The Higgsfield API docs index (GET /docs/llms.txt) as structured rows: every linked page with title, path, group, description and URLs, the group names, and the index's model discovery and source priority guidance. The index lists the shared guides and reference pages; model pages come from list_models. Filter by group or text.
- [Search docs](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/search_docs): Search the Higgsfield API docs through Higgsfield's public Mintlify docs MCP server (search_higgsfield_api_docs). Returns ranked hits in the vendor's order with title, URL, page path, section anchor and a Markdown snippet. The search is semantic, so unusual queries can return loosely related hits.

## 1. Choose this provider when

Official Higgsfield API documentation from docs.higgsfield.ai: search through Higgsfield's public Mintlify docs MCP server, any page as clean Markdown with an outline and section reads, the llms.txt page index, the published OpenAPI operations, the image and video model catalog, and each model's workflows with endpoint, endpoint ID, usage notes and the full request JSON Schema. Public agent-facing sources only; no login or key. Plan prices and credit costs (higgsfield.ai) are not covered.

## 2. Minimal request

Call `POST https://api.firecrawl.dev/v2/scrape` with `{ alexandria: { provider, capability, options } }`. For a batch, send `{ alexandria: [...] }` with up to 10 calls.

```json
{
  "provider": "docs-higgsfield-ai",
  "capability": "developer-documentation/get_model",
  "options": {
    "model": "kling-3",
    "workflow": "pro-text-to-video"
  }
}
```

## 3. Add provider options

Use only the options needed for the task:

- `model` (string, required): Model family slug from list_models (e.g. kling-3), a model/workflow path (kling-3/pro-text-to-video) or a model docs URL. Example: `<model>`
- `workflow` (string): Workflow slug from the family's workflows, e.g. pro-text-to-video. Example: `<workflow>`

## 4. Request through your preferred interface

### JavaScript

```javascript
const result = await firecrawl.scrape({
  alexandria: {
    provider: "docs-higgsfield-ai",
    capability: "developer-documentation/get_model",
    options: {
      model: "kling-3",
      workflow: "pro-text-to-video",
    },
  },
});
```

### Python

```python
result = firecrawl.scrape_alexandria({
  "provider": "docs-higgsfield-ai",
  "capability": "developer-documentation/get_model",
  "options": {
    "model": "kling-3",
    "workflow": "pro-text-to-video"
  }
})
```

### cURL

```sh
curl https://api.firecrawl.dev/v2/scrape \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "alexandria": {
    "provider": "docs-higgsfield-ai",
    "capability": "developer-documentation/get_model",
    "options": {
      "model": "kling-3",
      "workflow": "pro-text-to-video"
    }
  }
}'
```

### CLI

```sh
firecrawl scrape 'docs-higgsfield-ai/developer-documentation/get_model' \
  --options '{"model":"kling-3","workflow":"pro-text-to-video"}'
```


### MCP

Call the FCX MCP retrieve tool with this object:

```json
{
  "provider": "docs-higgsfield-ai",
  "capability": "developer-documentation/get_model",
  "options": {
    "model": "kling-3",
    "workflow": "pro-text-to-video"
  }
}
```

Ask for only the returned fields needed by the task.

## 5. Full request shape

```json
{
  "provider": "docs-higgsfield-ai",
  "capability": "developer-documentation/get_model",
  "options": {
    "model": "kling-3",
    "workflow": "pro-text-to-video"
  }
}
```

## 6. Response data

The response includes `success`, `provider`, `capability`, `creditsCost` and `data`. This example shows the provider payload in `data`:

```json
{
  "description": "Generate videos with Standard, Pro, 4K and Turbo workflow variants.",
  "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3.md",
  "name": "Kling 3.0",
  "observed_at_ms": 1792693200000,
  "slug": "kling-3",
  "url": "https://docs.higgsfield.ai/docs/models/kling-3",
  "workflow": {
    "description": "Pro · Text to video with Kling 3.0: request parameters, examples and response handling.",
    "endpoint_id": "kling-video/v3.0/pro/text-to-video",
    "endpoint_url": "https://api.higgsfield.ai/kling-video/v3.0/pro/text-to-video",
    "input_schema": "{\"properties\":{\"aspect_ratio\":{\"default\":\"16:9\",\"enum\":[\"16:9\",\"9:16\",\"1:1\"],\"title\":\"Aspect ratio\",\"type\":\"string\"},\"cfg_scale\":{\"default\":0.5,\"maximum\":1,\"minimum\":0,\"multipleOf\":0.01,\"title\":\"CFG Scale\",\"type\":\"number\"},\"duration\":{\"default\":5,\"maximum\":15,\"minimum\":3,\"title\":\"Duration\",\"type\":\"integer\"},\"elements\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"multi_prompt\":{\"items\":{\"properties\":{\"duration\":{\"maximum\":15,\"minimum\":1,\"type\":\"integer\"},\"prompt\":{\"maxLength\":512,\"type\":\"string\"}},\"type\":\"object\"},\"maxItems\":6,\"minItems\":0,\"type\":\"array\"},\"multi_shots\":{\"default\":false,\"type\":\"boolean\"},\"prompt\":{\"description\":\"Write your prompt here\",\"title\":\"Prompt\",\"type\":\"string\"},\"sound\":{\"default\":\"on\",\"enum\":[\"on\",\"off\"],\"title\":\"Generate sound\",\"type\":\"string\"}},\"title\":\"Kling 3.0 Playground\",\"type\":\"object\"}",
    "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-text-to-video.md",
    "method": "POST",
    "parameters": [
      "aspect_ratio",
      "cfg_scale",
      "duration",
      "elements",
      "multi_prompt",
      "multi_shots",
      "prompt",
      "sound"
    ],
    "path": "models/kling-3/pro-text-to-video",
    "playground_url": "https://console.higgsfield.ai/models/kling-video%2Fv3.0%2Fpro%2Ftext-to-video/playground",
    "required": [],
    "slug": "pro-text-to-video",
    "title": "Kling 3.0 — Pro · Text to video",
    "url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-text-to-video",
    "usage_notes": [
      "Always include a non-empty top-level prompt, including when using multi_prompt. Keep it within 2,500 characters; longer prompts are truncated.",
      "For custom shots, set multi_shots to true and provide 1–6 multi_prompt objects. Each object needs prompt (at most 512 characters) and duration (a positive integer from 1 to 15 seconds).",
      "Custom-shot durations are summed for generation and billing; the top-level duration does not override that sum. With multi_shots enabled and no custom shots, the top-level duration is retained.",
      "Native audio uses sound: on or off and defaults to on.",
      "elements contains Kling element IDs as decimal strings. Each ID must belong to the account making the request; arbitrary provider IDs are rejected."
    ]
  },
  "workflow_count": 8,
  "workflows": [
    {
      "endpoint": "/kling-video/v3.0/4k/text-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/4k-text-to-video.md",
      "method": "POST",
      "name": "4K · Text to video",
      "path": "models/kling-3/4k-text-to-video",
      "slug": "4k-text-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/4k-text-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/pro/text-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-text-to-video.md",
      "method": "POST",
      "name": "Pro · Text to video",
      "path": "models/kling-3/pro-text-to-video",
      "slug": "pro-text-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-text-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/std/text-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/standard-text-to-video.md",
      "method": "POST",
      "name": "Standard · Text to video",
      "path": "models/kling-3/standard-text-to-video",
      "slug": "standard-text-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/standard-text-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0-turbo/text-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/turbo-text-to-video.md",
      "method": "POST",
      "name": "Turbo · Text to video",
      "path": "models/kling-3/turbo-text-to-video",
      "slug": "turbo-text-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/turbo-text-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/4k/image-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/4k-image-to-video.md",
      "method": "POST",
      "name": "4K · Image to video",
      "path": "models/kling-3/4k-image-to-video",
      "slug": "4k-image-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/4k-image-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/pro/image-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-image-to-video.md",
      "method": "POST",
      "name": "Pro · Image to video",
      "path": "models/kling-3/pro-image-to-video",
      "slug": "pro-image-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-image-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/std/image-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/standard-image-to-video.md",
      "method": "POST",
      "name": "Standard · Image to video",
      "path": "models/kling-3/standard-image-to-video",
      "slug": "standard-image-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/standard-image-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0-turbo/image-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/turbo-image-to-video.md",
      "method": "POST",
      "name": "Turbo · Image to video",
      "path": "models/kling-3/turbo-image-to-video",
      "slug": "turbo-image-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/turbo-image-to-video"
    }
  ]
}
```

## API reference-derived contract

The following capability contract is generated from the same normalized Alexandria API reference exposed in the API spec.

### Get model

- Capability: `developer-documentation/get_model`
- Description: One Higgsfield API model family (GET /docs/models/{model}.md): name, description and every workflow with its method and API endpoint. With workflow (or a model/workflow path) it also reads that workflow page and returns the full submission URL, endpoint ID, Playground link, usage notes, top-level and required parameters, and the complete request JSON Schema. Unknown models and workflows are not_found.
- Instructions: To build or check a Higgsfield API request for a specific model: which endpoints a family offers, and the exact parameters, allowed values and defaults a workflow accepts. Credit costs are not published in the docs (the estimate endpoint needs an API key).
- Cost: 5 credits per call
- Capability file: [Get model](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/get_model)

Accepted options:
- `model` (string, required): Model family slug from list_models (e.g. kling-3), a model/workflow path (kling-3/pro-text-to-video) or a model docs URL. Example: `<model>`
- `workflow` (string): Workflow slug from the family's workflows, e.g. pro-text-to-video. Example: `<workflow>`

Response schema example:
```json
{
  "description": "Generate videos with Standard, Pro, 4K and Turbo workflow variants.",
  "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3.md",
  "name": "Kling 3.0",
  "observed_at_ms": 1792693200000,
  "slug": "kling-3",
  "url": "https://docs.higgsfield.ai/docs/models/kling-3",
  "workflow": {
    "description": "Pro · Text to video with Kling 3.0: request parameters, examples and response handling.",
    "endpoint_id": "kling-video/v3.0/pro/text-to-video",
    "endpoint_url": "https://api.higgsfield.ai/kling-video/v3.0/pro/text-to-video",
    "input_schema": "{\"properties\":{\"aspect_ratio\":{\"default\":\"16:9\",\"enum\":[\"16:9\",\"9:16\",\"1:1\"],\"title\":\"Aspect ratio\",\"type\":\"string\"},\"cfg_scale\":{\"default\":0.5,\"maximum\":1,\"minimum\":0,\"multipleOf\":0.01,\"title\":\"CFG Scale\",\"type\":\"number\"},\"duration\":{\"default\":5,\"maximum\":15,\"minimum\":3,\"title\":\"Duration\",\"type\":\"integer\"},\"elements\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"multi_prompt\":{\"items\":{\"properties\":{\"duration\":{\"maximum\":15,\"minimum\":1,\"type\":\"integer\"},\"prompt\":{\"maxLength\":512,\"type\":\"string\"}},\"type\":\"object\"},\"maxItems\":6,\"minItems\":0,\"type\":\"array\"},\"multi_shots\":{\"default\":false,\"type\":\"boolean\"},\"prompt\":{\"description\":\"Write your prompt here\",\"title\":\"Prompt\",\"type\":\"string\"},\"sound\":{\"default\":\"on\",\"enum\":[\"on\",\"off\"],\"title\":\"Generate sound\",\"type\":\"string\"}},\"title\":\"Kling 3.0 Playground\",\"type\":\"object\"}",
    "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-text-to-video.md",
    "method": "POST",
    "parameters": [
      "aspect_ratio",
      "cfg_scale",
      "duration",
      "elements",
      "multi_prompt",
      "multi_shots",
      "prompt",
      "sound"
    ],
    "path": "models/kling-3/pro-text-to-video",
    "playground_url": "https://console.higgsfield.ai/models/kling-video%2Fv3.0%2Fpro%2Ftext-to-video/playground",
    "required": [],
    "slug": "pro-text-to-video",
    "title": "Kling 3.0 — Pro · Text to video",
    "url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-text-to-video",
    "usage_notes": [
      "Always include a non-empty top-level prompt, including when using multi_prompt. Keep it within 2,500 characters; longer prompts are truncated.",
      "For custom shots, set multi_shots to true and provide 1–6 multi_prompt objects. Each object needs prompt (at most 512 characters) and duration (a positive integer from 1 to 15 seconds).",
      "Custom-shot durations are summed for generation and billing; the top-level duration does not override that sum. With multi_shots enabled and no custom shots, the top-level duration is retained.",
      "Native audio uses sound: on or off and defaults to on.",
      "elements contains Kling element IDs as decimal strings. Each ID must belong to the account making the request; arbitrary provider IDs are rejected."
    ]
  },
  "workflow_count": 8,
  "workflows": [
    {
      "endpoint": "/kling-video/v3.0/4k/text-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/4k-text-to-video.md",
      "method": "POST",
      "name": "4K · Text to video",
      "path": "models/kling-3/4k-text-to-video",
      "slug": "4k-text-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/4k-text-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/pro/text-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-text-to-video.md",
      "method": "POST",
      "name": "Pro · Text to video",
      "path": "models/kling-3/pro-text-to-video",
      "slug": "pro-text-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-text-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/std/text-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/standard-text-to-video.md",
      "method": "POST",
      "name": "Standard · Text to video",
      "path": "models/kling-3/standard-text-to-video",
      "slug": "standard-text-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/standard-text-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0-turbo/text-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/turbo-text-to-video.md",
      "method": "POST",
      "name": "Turbo · Text to video",
      "path": "models/kling-3/turbo-text-to-video",
      "slug": "turbo-text-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/turbo-text-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/4k/image-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/4k-image-to-video.md",
      "method": "POST",
      "name": "4K · Image to video",
      "path": "models/kling-3/4k-image-to-video",
      "slug": "4k-image-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/4k-image-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/pro/image-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-image-to-video.md",
      "method": "POST",
      "name": "Pro · Image to video",
      "path": "models/kling-3/pro-image-to-video",
      "slug": "pro-image-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/pro-image-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0/std/image-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/standard-image-to-video.md",
      "method": "POST",
      "name": "Standard · Image to video",
      "path": "models/kling-3/standard-image-to-video",
      "slug": "standard-image-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/standard-image-to-video"
    },
    {
      "endpoint": "/kling-video/v3.0-turbo/image-to-video",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3/turbo-image-to-video.md",
      "method": "POST",
      "name": "Turbo · Image to video",
      "path": "models/kling-3/turbo-image-to-video",
      "slug": "turbo-image-to-video",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3/turbo-image-to-video"
    }
  ]
}
```

### Get page

- Capability: `developer-documentation/get_page`
- Description: One Higgsfield API docs page as clean Markdown (GET /docs/{path}.md, the docs' agent-facing rendering) with title, description, an outline of headings with anchors, and the content. section (heading text or anchor, case-insensitive) returns only that heading and its subsections. Accepts a page path or any docs.higgsfield.ai URL (the site root and /docs map to the overview page, .md URLs are accepted); an anchor in the URL selects that section. Unknown pages and sections are not_found.
- Instructions: To read primary Higgsfield API documentation: quickstart, authentication, request lifecycle, polling, webhooks, file uploads, errors, rate limits, billing and retention, SDKs, or a model workflow page. Call without section (with a small max_chars) to see the outline, then fetch the section you need.
- Cost: 5 credits per call
- Capability file: [Get page](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/get_page)

Accepted options:
- `max_chars` (number): Cut content to this many characters. The whole page or section is returned when omitted. Example: `200`
- `path` (string): Page path such as quickstart, how-to/webhooks or concepts/polling.md#retry-decisions. A leading docs/ and .md are accepted; index is the overview page. Example: `<path>`
- `section` (string): Heading text or anchor of the section to return, e.g. Delivery and retries or delivery-and-retries. Example: `<section>`
- `url` (string): Alternatively a page URL, e.g. https://docs.higgsfield.ai/docs/how-to/webhooks#delivery-and-retries. Pattern: ^https?://. Example: `<url>`

Response schema example:
```json
{
  "chars": 528,
  "content": "## Delivery and retries\n\n* Return any `2xx` response after durably recording the event.\n* Network failures and `5xx` responses are retried for up to two hours.\n* `4xx` responses are treated as permanent and are not retried.\n* Duplicate deliveries are possible. Deduplicate by `request_id` and terminal `status`.\n* If delivery fails permanently, retrieve the result through the authenticated status endpoint.\n\nReject request bodies that do not match the documented envelope, but acknowledge valid duplicate deliveries with `2xx`.",
  "description": "Receive terminal generation results without continuous polling.",
  "markdown_url": "https://docs.higgsfield.ai/docs/how-to/webhooks.md",
  "observed_at_ms": 1792693200000,
  "outline": [
    {
      "anchor": "delivery-and-retries",
      "level": 2,
      "text": "Delivery and retries"
    }
  ],
  "path": "how-to/webhooks",
  "section": {
    "anchor": "delivery-and-retries",
    "level": 2,
    "text": "Delivery and retries",
    "url": "https://docs.higgsfield.ai/docs/how-to/webhooks#delivery-and-retries"
  },
  "title": "Webhooks",
  "truncated": false,
  "url": "https://docs.higgsfield.ai/docs/how-to/webhooks"
}
```

### List endpoints

- Capability: `developer-documentation/list_endpoints`
- Description: The operations in Higgsfield's published OpenAPI specification (GET /docs/openapi.json): method, path, operation ID, summary, description, tags, parameters, request-body flag and response codes, plus the spec title, version and servers. Higgsfield marks this file as supplementary: it covers the shared request status and cancel endpoints and a few model endpoints, while get_model has every model workflow. Filter by tag or text.
- Instructions: For the shared API reference (request status, cancel) and a machine-readable view of the documented operations. Use get_model for a specific model's request schema.
- Cost: 5 credits per call
- Capability file: [List endpoints](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/list_endpoints)

Accepted options:
- `q` (string): Case-insensitive text matched against path, summary and description. Example: `<q>`
- `tag` (string): Exact tag, case-insensitive, e.g. Requests. Example: `<tag>`
- `url` (string): The specification URL, https://docs.higgsfield.ai/docs/openapi.json. Pattern: ^https?://. Example: `<url>`

Response schema example:
```json
{
  "count": 2,
  "endpoints": [
    {
      "description": "Cancel a request that has not started processing. A successful response has no body.",
      "has_request_body": false,
      "method": "POST",
      "operation_id": "cancel_request",
      "parameters": [
        {
          "in": "path",
          "name": "request_id",
          "required": true
        }
      ],
      "path": "/requests/{request_id}/cancel",
      "responses": [
        "202",
        "400",
        "401",
        "404"
      ],
      "summary": "Cancel a queued request",
      "tags": [
        "Requests"
      ]
    },
    {
      "description": "Retrieve the current state and output of a generation request.",
      "has_request_body": false,
      "method": "GET",
      "operation_id": "get_request_status",
      "parameters": [
        {
          "in": "path",
          "name": "request_id",
          "required": true
        }
      ],
      "path": "/requests/{request_id}/status",
      "responses": [
        "200",
        "401",
        "404"
      ],
      "summary": "Get request status",
      "tags": [
        "Requests"
      ]
    }
  ],
  "observed_at_ms": 1792693200000,
  "q": null,
  "servers": [
    "https://api.higgsfield.ai"
  ],
  "source_url": "https://docs.higgsfield.ai/docs/openapi.json",
  "tag": "Requests",
  "title": "Higgsfield API",
  "total": 8,
  "version": "2.0.0"
}
```

### List models

- Capability: `developer-documentation/list_models`
- Description: The Higgsfield API model catalog: every image and video model family from the docs catalog pages (GET /docs/models/video-generation.md and image-generation.md) with slug, name, category, vendor, workflow count and description, plus the counts each catalog page states. Filter by category, vendor or a text query.
- Instructions: To see which models the Higgsfield API documents (Kling, Seedance, Wan, MiniMax, SOUL, Recraft and more) before choosing one. Pass a family slug to get_model for its workflows and request schema.
- Cost: 5 credits per call
- Capability file: [List models](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/list_models)

Accepted options:
- `category` (string): Only this catalog (fetches one page instead of two). Example: `video`
- `q` (string): Case-insensitive model or family name text matched against slug, name and description, e.g. seedance, soul or kling. Example: `<q>`
- `url` (string): A catalog page URL (https://docs.higgsfield.ai/docs/models/video-generation or image-generation); selects that category. Pattern: ^https?://. Example: `<url>`
- `vendor` (string): Exact vendor, case-insensitive, e.g. Kling. Example: `<vendor>`

Response schema example:
```json
{
  "catalogs": [
    {
      "category": "video",
      "declared_entries": 67,
      "declared_families": 22,
      "source_url": "https://docs.higgsfield.ai/docs/models/video-generation.md"
    },
    {
      "category": "image",
      "declared_entries": 17,
      "declared_families": 14,
      "source_url": "https://docs.higgsfield.ai/docs/models/image-generation.md"
    }
  ],
  "category": null,
  "count": 36,
  "models": [
    {
      "category": "video",
      "description": "Transfer motion, replace objects, or restyle a source video.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/genjutsu.md",
      "name": "Genjutsu",
      "slug": "genjutsu",
      "url": "https://docs.higgsfield.ai/docs/models/genjutsu",
      "vendor": "Higgsfield",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate videos from text, frames or image, video and audio references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/seedance-2.md",
      "name": "Seedance 2.0",
      "slug": "seedance-2",
      "url": "https://docs.higgsfield.ai/docs/models/seedance-2",
      "vendor": "ByteDance",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate, edit and extend videos using text and multimodal references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/seedance-2-5.md",
      "name": "Seedance 2.5",
      "slug": "seedance-2-5",
      "url": "https://docs.higgsfield.ai/docs/models/seedance-2-5",
      "vendor": "ByteDance",
      "workflow_count": 5
    },
    {
      "category": "video",
      "description": "Generate videos with Standard and Pro workflow variants.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-2-5-turbo.md",
      "name": "Kling 2.5 Turbo",
      "slug": "kling-2-5-turbo",
      "url": "https://docs.higgsfield.ai/docs/models/kling-2-5-turbo",
      "vendor": "Kling",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate videos from text or a starting image, with optional sound.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-2-6.md",
      "name": "Kling 2.6",
      "slug": "kling-2-6",
      "url": "https://docs.higgsfield.ai/docs/models/kling-2-6",
      "vendor": "Kling",
      "workflow_count": 2
    },
    {
      "category": "video",
      "description": "Apply motion from a source video to an image with Standard or Pro processing.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-2-6-motion-control.md",
      "name": "Kling 2.6 Motion Control",
      "slug": "kling-2-6-motion-control",
      "url": "https://docs.higgsfield.ai/docs/models/kling-2-6-motion-control",
      "vendor": "Kling",
      "workflow_count": 2
    },
    {
      "category": "video",
      "description": "Generate videos with Standard, Pro, 4K and Turbo workflow variants.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3.md",
      "name": "Kling 3.0",
      "slug": "kling-3",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3",
      "vendor": "Kling",
      "workflow_count": 8
    },
    {
      "category": "video",
      "description": "Apply motion from a source video to an image with Standard or Pro processing.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-3-motion-control.md",
      "name": "Kling 3.0 Motion Control",
      "slug": "kling-3-motion-control",
      "url": "https://docs.higgsfield.ai/docs/models/kling-3-motion-control",
      "vendor": "Kling",
      "workflow_count": 2
    },
    {
      "category": "video",
      "description": "Create and edit videos with first/last frames, image references and video references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-o3.md",
      "name": "Kling O3",
      "slug": "kling-o3",
      "url": "https://docs.higgsfield.ai/docs/models/kling-o3",
      "vendor": "Kling",
      "workflow_count": 4
    },
    {
      "category": "video",
      "description": "Create and edit videos with image and video references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/kling-omni.md",
      "name": "Kling Omni",
      "slug": "kling-omni",
      "url": "https://docs.higgsfield.ai/docs/models/kling-omni",
      "vendor": "Kling",
      "workflow_count": 4
    },
    {
      "category": "video",
      "description": "Generate videos from text, a starting image or reference images.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/happy-horse-1.md",
      "name": "Happy Horse 1.0",
      "slug": "happy-horse-1",
      "url": "https://docs.higgsfield.ai/docs/models/happy-horse-1",
      "vendor": "Alibaba",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate videos from text, a starting image or reference images.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/happy-horse-1-1.md",
      "name": "HappyHorse 1.1",
      "slug": "happy-horse-1-1",
      "url": "https://docs.higgsfield.ai/docs/models/happy-horse-1-1",
      "vendor": "Alibaba",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate videos from text, frames or multimodal references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/wan-3.md",
      "name": "Wan 3.0",
      "slug": "wan-3",
      "url": "https://docs.higgsfield.ai/docs/models/wan-3",
      "vendor": "Alibaba",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate videos from text, frames or multimodal references with Wan 3.0 Prime.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/wan-3-prime.md",
      "name": "Wan 3.0 Prime",
      "slug": "wan-3-prime",
      "url": "https://docs.higgsfield.ai/docs/models/wan-3-prime",
      "vendor": "Alibaba",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Create video shots with camera and style controls and media references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/cinema-studio-4.md",
      "name": "Cinema Studio 4.0",
      "slug": "cinema-studio-4",
      "url": "https://docs.higgsfield.ai/docs/models/cinema-studio-4",
      "vendor": "Higgsfield",
      "workflow_count": 1
    },
    {
      "category": "video",
      "description": "Generate videos from text or images with Fast and Pro variants.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/ltx-2-5.md",
      "name": "LTX-2.5",
      "slug": "ltx-2-5",
      "url": "https://docs.higgsfield.ai/docs/models/ltx-2-5",
      "vendor": "Lightricks",
      "workflow_count": 4
    },
    {
      "category": "video",
      "description": "Generate videos from text, frames or multimodal references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/minimax-h3.md",
      "name": "MiniMax H3",
      "slug": "minimax-h3",
      "url": "https://docs.higgsfield.ai/docs/models/minimax-h3",
      "vendor": "MiniMax",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate videos from text or an image with Hailuo 2.3 Standard.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/hailuo-2-3.md",
      "name": "Hailuo 2.3",
      "slug": "hailuo-2-3",
      "url": "https://docs.higgsfield.ai/docs/models/hailuo-2-3",
      "vendor": "MiniMax",
      "workflow_count": 2
    },
    {
      "category": "video",
      "description": "Generate videos from text or images with optional sound.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/pixverse-v6.md",
      "name": "PixVerse V6",
      "slug": "pixverse-v6",
      "url": "https://docs.higgsfield.ai/docs/models/pixverse-v6",
      "vendor": "PixVerse",
      "workflow_count": 2
    },
    {
      "category": "video",
      "description": "Generate videos from text, images or video references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/wan-2-6.md",
      "name": "Wan 2.6",
      "slug": "wan-2-6",
      "url": "https://docs.higgsfield.ai/docs/models/wan-2-6",
      "vendor": "Alibaba",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate videos from text, frames or multimodal references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/wan-2-7.md",
      "name": "Wan 2.7",
      "slug": "wan-2-7",
      "url": "https://docs.higgsfield.ai/docs/models/wan-2-7",
      "vendor": "Alibaba",
      "workflow_count": 3
    },
    {
      "category": "video",
      "description": "Generate videos from text, images or an audio reference.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/grok-video-1-5.md",
      "name": "Grok Imagine Video 1.5",
      "slug": "grok-video-1-5",
      "url": "https://docs.higgsfield.ai/docs/models/grok-video-1-5",
      "vendor": "xAI",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate images with selectable styles and adjustable style strength.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/soul-standard.md",
      "name": "SOUL",
      "slug": "soul-standard",
      "url": "https://docs.higgsfield.ai/docs/models/soul-standard",
      "vendor": "Higgsfield",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate portraits, fashion and editorial images with SOUL styles.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/soul-2.md",
      "name": "SOUL V2",
      "slug": "soul-2",
      "url": "https://docs.higgsfield.ai/docs/models/soul-2",
      "vendor": "Higgsfield",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate cinema-inspired still images from text prompts.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/soul-cinema.md",
      "name": "SOUL Cinema",
      "slug": "soul-cinema",
      "url": "https://docs.higgsfield.ai/docs/models/soul-cinema",
      "vendor": "Higgsfield",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Train a personal character from reference images for use with compatible SOUL workflows.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/soul-id.md",
      "name": "Soul ID",
      "slug": "soul-id",
      "url": "https://docs.higgsfield.ai/docs/models/soul-id",
      "vendor": "Higgsfield",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate and edit campaign images, with optional preset-based prompt enhancement.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/marketing-studio-image.md",
      "name": "Marketing Studio Image",
      "slug": "marketing-studio-image",
      "url": "https://docs.higgsfield.ai/docs/models/marketing-studio-image",
      "vendor": "Higgsfield",
      "workflow_count": 3
    },
    {
      "category": "image",
      "description": "Turn a marketing brief and optional product references into 1–8 ad concepts rendered as images with GPT Image 2.5 Flare.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/ads-studio.md",
      "name": "Ads Studio",
      "slug": "ads-studio",
      "url": "https://docs.higgsfield.ai/docs/models/ads-studio",
      "vendor": "Higgsfield",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate and edit images with up to ten image references.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/grok-image-2.md",
      "name": "Grok Image 2.0",
      "slug": "grok-image-2",
      "url": "https://docs.higgsfield.ai/docs/models/grok-image-2",
      "vendor": "xAI",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate 1K images with RGB palette and background controls.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/recraft-v4-1.md",
      "name": "Recraft V4.1",
      "slug": "recraft-v4-1",
      "url": "https://docs.higgsfield.ai/docs/models/recraft-v4-1",
      "vendor": "Recraft",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate 2K images with RGB palette and background controls.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/recraft-v4-1-pro.md",
      "name": "Recraft V4.1 Pro",
      "slug": "recraft-v4-1-pro",
      "url": "https://docs.higgsfield.ai/docs/models/recraft-v4-1-pro",
      "vendor": "Recraft",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate 1K images with RGB palette and background controls.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/recraft-v4-1-utility.md",
      "name": "Recraft V4.1 Utility",
      "slug": "recraft-v4-1-utility",
      "url": "https://docs.higgsfield.ai/docs/models/recraft-v4-1-utility",
      "vendor": "Recraft",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate 2K images with RGB palette and background controls.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/recraft-v4-1-utility-pro.md",
      "name": "Recraft V4.1 Utility Pro",
      "slug": "recraft-v4-1-utility-pro",
      "url": "https://docs.higgsfield.ai/docs/models/recraft-v4-1-utility-pro",
      "vendor": "Recraft",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate images or edit one to three reference images with optional prompt reasoning.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/qwen-image-3.md",
      "name": "Qwen Image 3",
      "slug": "qwen-image-3",
      "url": "https://docs.higgsfield.ai/docs/models/qwen-image-3",
      "vendor": "Alibaba",
      "workflow_count": 2
    },
    {
      "category": "image",
      "description": "Generate images with an optional image reference and selectable rendering speed.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/ideogram-4.md",
      "name": "Ideogram 4.0",
      "slug": "ideogram-4",
      "url": "https://docs.higgsfield.ai/docs/models/ideogram-4",
      "vendor": "Ideogram",
      "workflow_count": 1
    },
    {
      "category": "image",
      "description": "Generate images at 1K or 2K with optional prompt enhancement.",
      "markdown_url": "https://docs.higgsfield.ai/docs/models/z-image-turbo.md",
      "name": "Z-Image Turbo",
      "slug": "z-image-turbo",
      "url": "https://docs.higgsfield.ai/docs/models/z-image-turbo",
      "vendor": "Alibaba",
      "workflow_count": 1
    }
  ],
  "observed_at_ms": 1792693200000,
  "q": null,
  "total": 36,
  "vendor": null
}
```

### List pages

- Capability: `developer-documentation/list_pages`
- Description: The Higgsfield API docs index (GET /docs/llms.txt) as structured rows: every linked page with title, path, group, description and URLs, the group names, and the index's model discovery and source priority guidance. The index lists the shared guides and reference pages; model pages come from list_models. Filter by group or text.
- Instructions: To see what the Higgsfield API docs cover (getting started, request lifecycle, SDKs, organizations, API reference, help) and pick a page for get_page, instead of fetching llms.txt raw.
- Cost: 5 credits per call
- Capability file: [List pages](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/list_pages)

Accepted options:
- `group` (string): Exact group heading, case-insensitive, e.g. Request lifecycle and media. Example: `<group>`
- `q` (string): Case-insensitive text matched against title, path and description. Example: `<q>`
- `url` (string): The index URL, https://docs.higgsfield.ai/docs/llms.txt (the root /llms.txt is accepted and read from /docs/llms.txt). Pattern: ^https?://. Example: `<url>`

Response schema example:
```json
{
  "count": 20,
  "group": null,
  "groups": [
    "Getting started",
    "Request lifecycle and media",
    "SDKs",
    "Organizations",
    "Shared API reference",
    "Help",
    "Supplementary OpenAPI specification"
  ],
  "guidance": [
    "Start at https://console.higgsfield.ai to discover models and open their model-specific API documentation.",
    "Use the selected model’s documentation for its endpoint, request schema, supported parameters, and examples. Follow its model-specific `llms.txt` link when available.",
    "Use https://docs.higgsfield.ai/docs/llms.txt for shared authentication, SDK, polling, webhook, and error-handling guidance.",
    "Treat `/docs/openapi.json` as supplementary reference, not the authoritative model catalog. A model’s absence from that file does not establish that it is unavailable.",
    "Check whether model documentation targets production or preview. Do not silently substitute environments, endpoints, or models.",
    "If sources conflict or access prevents verification, describe the specific uncertainty. Distinguish documented availability from access verified with the user’s account."
  ],
  "observed_at_ms": 1792693200000,
  "pages": [
    {
      "description": "Platform overview.",
      "group": "Getting started",
      "markdown_url": "https://docs.higgsfield.ai/docs/index.md",
      "path": "index",
      "title": "Higgsfield API",
      "url": "https://docs.higgsfield.ai/docs"
    },
    {
      "description": "First generation walkthrough.",
      "group": "Getting started",
      "markdown_url": "https://docs.higgsfield.ai/docs/quickstart.md",
      "path": "quickstart",
      "title": "Quickstart",
      "url": "https://docs.higgsfield.ai/docs/quickstart"
    },
    {
      "description": "Credentials and secure API access.",
      "group": "Getting started",
      "markdown_url": "https://docs.higgsfield.ai/docs/authentication.md",
      "path": "authentication",
      "title": "Authentication",
      "url": "https://docs.higgsfield.ai/docs/authentication"
    },
    {
      "description": "Shared generation workflow.",
      "group": "Getting started",
      "markdown_url": "https://docs.higgsfield.ai/docs/how-to/introduction.md",
      "path": "how-to/introduction",
      "title": "How the API works",
      "url": "https://docs.higgsfield.ai/docs/how-to/introduction"
    },
    {
      "description": "Request identifiers, states, and outputs.",
      "group": "Request lifecycle and media",
      "markdown_url": "https://docs.higgsfield.ai/docs/concepts/requests.md",
      "path": "concepts/requests",
      "title": "Requests and lifecycle",
      "url": "https://docs.higgsfield.ai/docs/concepts/requests"
    },
    {
      "description": "Status checks and backoff.",
      "group": "Request lifecycle and media",
      "markdown_url": "https://docs.higgsfield.ai/docs/concepts/polling.md",
      "path": "concepts/polling",
      "title": "Polling",
      "url": "https://docs.higgsfield.ai/docs/concepts/polling"
    },
    {
      "description": "Completion notifications and delivery handling.",
      "group": "Request lifecycle and media",
      "markdown_url": "https://docs.higgsfield.ai/docs/how-to/webhooks.md",
      "path": "how-to/webhooks",
      "title": "Webhooks",
      "url": "https://docs.higgsfield.ai/docs/how-to/webhooks"
    },
    {
      "description": "Preparing input media.",
      "group": "Request lifecycle and media",
      "markdown_url": "https://docs.higgsfield.ai/docs/concepts/file-uploads.md",
      "path": "concepts/file-uploads",
      "title": "File uploads",
      "url": "https://docs.higgsfield.ai/docs/concepts/file-uploads"
    },
    {
      "description": "Failure handling and retry decisions.",
      "group": "Request lifecycle and media",
      "markdown_url": "https://docs.higgsfield.ai/docs/concepts/errors.md",
      "path": "concepts/errors",
      "title": "Errors and retries",
      "url": "https://docs.higgsfield.ai/docs/concepts/errors"
    },
    {
      "description": "Account and model limits.",
      "group": "Request lifecycle and media",
      "markdown_url": "https://docs.higgsfield.ai/docs/concepts/rate-limits.md",
      "path": "concepts/rate-limits",
      "title": "Rate limits",
      "url": "https://docs.higgsfield.ai/docs/concepts/rate-limits"
    },
    {
      "description": "Charges and output availability.",
      "group": "Request lifecycle and media",
      "markdown_url": "https://docs.higgsfield.ai/docs/concepts/billing-and-retention.md",
      "path": "concepts/billing-and-retention",
      "title": "Billing and retention",
      "url": "https://docs.higgsfield.ai/docs/concepts/billing-and-retention"
    },
    {
      "description": "Official Python and TypeScript clients.",
      "group": "SDKs",
      "markdown_url": "https://docs.higgsfield.ai/docs/how-to/sdk.md",
      "path": "how-to/sdk",
      "title": "Client libraries",
      "url": "https://docs.higgsfield.ai/docs/how-to/sdk"
    },
    {
      "description": "Organization setup and collaboration.",
      "group": "Organizations",
      "markdown_url": "https://docs.higgsfield.ai/docs/organizations.md",
      "path": "organizations",
      "title": "Organizations",
      "url": "https://docs.higgsfield.ai/docs/organizations"
    },
    {
      "description": "Membership and access management.",
      "group": "Organizations",
      "markdown_url": "https://docs.higgsfield.ai/docs/organizations/managing-members.md",
      "path": "organizations/managing-members",
      "title": "Managing members",
      "url": "https://docs.higgsfield.ai/docs/organizations/managing-members"
    },
    {
      "description": "API reference overview.",
      "group": "Shared API reference",
      "markdown_url": "https://docs.higgsfield.ai/docs/api-reference/overview.md",
      "path": "api-reference/overview",
      "title": "API reference",
      "url": "https://docs.higgsfield.ai/docs/api-reference/overview"
    },
    {
      "description": "Check a submitted request.",
      "group": "Shared API reference",
      "markdown_url": "https://docs.higgsfield.ai/docs/api-reference/requests/get-request-status.md",
      "path": "api-reference/requests/get-request-status",
      "title": "Get request status",
      "url": "https://docs.higgsfield.ai/docs/api-reference/requests/get-request-status"
    },
    {
      "description": "Cancel eligible pending work.",
      "group": "Shared API reference",
      "markdown_url": "https://docs.higgsfield.ai/docs/api-reference/requests/cancel-a-queued-request.md",
      "path": "api-reference/requests/cancel-a-queued-request",
      "title": "Cancel a queued request",
      "url": "https://docs.higgsfield.ai/docs/api-reference/requests/cancel-a-queued-request"
    },
    {
      "description": "Common integration questions.",
      "group": "Help",
      "markdown_url": "https://docs.higgsfield.ai/docs/help/faq.md",
      "path": "help/faq",
      "title": "FAQ",
      "url": "https://docs.higgsfield.ai/docs/help/faq"
    },
    {
      "description": "Contact and troubleshooting resources.",
      "group": "Help",
      "markdown_url": "https://docs.higgsfield.ai/docs/help/support.md",
      "path": "help/support",
      "title": "Support",
      "url": "https://docs.higgsfield.ai/docs/help/support"
    },
    {
      "description": "Supplementary machine-readable reference. Apply the model discovery and source priority guidance above.",
      "group": "Supplementary OpenAPI specification",
      "markdown_url": "https://docs.higgsfield.ai/docs/openapi.json",
      "path": "openapi.json",
      "title": "OpenAPI specification",
      "url": "https://docs.higgsfield.ai/docs/openapi.json"
    }
  ],
  "q": null,
  "source_url": "https://docs.higgsfield.ai/docs/llms.txt",
  "total": 20
}
```

### Search docs

- Capability: `developer-documentation/search_docs`
- Description: Search the Higgsfield API docs through Higgsfield's public Mintlify docs MCP server (search_higgsfield_api_docs). Returns ranked hits in the vendor's order with title, URL, page path, section anchor and a Markdown snippet. The search is semantic, so unusual queries can return loosely related hits.
- Instructions: To find which Higgsfield API docs page or model workflow covers a topic (authentication, polling, webhooks, uploads, rate limits, a model's parameters). Pass a hit's path and anchor to get_page as path and section.
- Cost: 5 credits per call
- Capability file: [Search docs](https://firecrawl.dev/alexandria/agents/providers/docs-higgsfield-ai/developer-documentation/search_docs)

Accepted options:
- `limit` (number): Maximum hits, 1-10 (the server returns at most 10). Defaults to 10. Example: `10`
- `max_snippet_chars` (number): Cut each snippet to this many characters. Defaults to 1500. Example: `100`
- `query` (string, required): Search text, e.g. webhook delivery retries. Example: `<query>`

Response schema example:
```json
{
  "count": 3,
  "observed_at_ms": 1792693200000,
  "query": "webhook delivery retries",
  "results": [
    {
      "anchor": "delivery-and-retries",
      "markdown_url": "https://docs.higgsfield.ai/docs/how-to/webhooks.md",
      "path": "how-to/webhooks",
      "rank": 1,
      "snippet": "## Delivery and retries\n\n* Return any `2xx` response after durably recording the event.\n* Network failures and `5xx` responses are retried for up to two hours.\n* `4xx` responses are treated as permanent and are not retried.\n* Duplicate deliveries are possible. Deduplicate by `request_id` and termina",
      "snippet_chars": 528,
      "snippet_truncated": true,
      "title": "Delivery and retries",
      "url": "https://docs.higgsfield.ai/docs/how-to/webhooks#delivery-and-retries"
    },
    {
      "anchor": "retry-after-an-ambiguous-failure",
      "markdown_url": "https://docs.higgsfield.ai/docs/concepts/idempotency.md",
      "path": "concepts/idempotency",
      "rank": 2,
      "snippet": "## Retry after an ambiguous failure\n\n1. Create the key before sending the generation request.\n2. Store the key with your local operation or job record.\n3. After a network error, timeout, or `5xx`, retry the same endpoint and parameters with the same key.\n4. Store the returned `request_id` and use it",
      "snippet_chars": 721,
      "snippet_truncated": true,
      "title": "Retry after an ambiguous failure",
      "url": "https://docs.higgsfield.ai/docs/concepts/idempotency#retry-after-an-ambiguous-failure"
    },
    {
      "anchor": "safe-retry-policy",
      "markdown_url": "https://docs.higgsfield.ai/docs/concepts/errors.md",
      "path": "concepts/errors",
      "rank": 3,
      "snippet": "## Safe retry policy\n\n* Retry `GET` status requests after network failures and `5xx` responses.\n* Do not retry authentication or validation failures without changing the request.\n* Use exponential backoff with jitter.\n* Set maximum attempts and a total retry deadline.\n* Send an [`Idempotency-Key`](/",
      "snippet_chars": 611,
      "snippet_truncated": true,
      "title": "Safe retry policy",
      "url": "https://docs.higgsfield.ai/docs/concepts/errors#safe-retry-policy"
    }
  ],
  "source_url": "https://docs.higgsfield.ai/docs/mcp"
}
```