Higgsfield Requests API

The Requests API from Higgsfield — 2 operation(s) for requests.

Operations 2

GET /requests/{request_id}/status Get request status #
POST /requests/{request_id}/cancel Cancel a queued request #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/higgsfield:higgsfield-requests-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

higgsfield-requests-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Higgsfield Requests API
  version: 2.0.0
  description: Submit generation requests and retrieve their status and outputs.
servers:
- url: https://api.higgsfield.ai
security:
- authKey: []
tags:
- name: Requests
paths:
  /requests/{request_id}/status:
    get:
      summary: Get request status
      operationId: get_request_status
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Request Id
      responses:
        '200':
          description: Current request state and output, when available.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestStatus'
        '401':
          description: Missing or invalid API credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The request does not exist or belongs to another account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Requests
      description: Retrieve the current state and output of a generation request.
  /requests/{request_id}/cancel:
    post:
      summary: Cancel a queued request
      operationId: cancel_request
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Request Id
      responses:
        '202':
          description: The request was canceled.
        '400':
          description: The request has already started and can no longer be canceled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The request does not exist or belongs to another account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Requests
      description: Cancel a request that has not started processing. A successful response has no body.
components:
  schemas:
    ErrorResponse:
      title: Error response
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
    RequestStatus:
      title: Request
      type: object
      properties:
        status:
          enum:
          - queued
          - in_progress
          - nsfw
          - failed
          - completed
          - canceled
          title: Status
          type: string
        request_id:
          type: string
          format: uuid
        status_url:
          type: string
          format: uri
        cancel_url:
          type: string
          format: uri
        error:
          type:
          - string
          - 'null'
        images:
          type: array
          items:
            $ref: '#/components/schemas/MediaOutput'
        video:
          $ref: '#/components/schemas/MediaOutput'
        audio:
          $ref: '#/components/schemas/MediaOutput'
        audios:
          type: array
          items:
            $ref: '#/components/schemas/MediaOutput'
      required:
      - status
      - request_id
    MediaOutput:
      title: Media output
      type: object
      additionalProperties: false
      properties:
        url:
          type: string
          format: uri
      required:
      - url
  securitySchemes:
    authKey:
      type: apiKey
      in: header
      name: Authorization
      description: Use `Key {api_key_id}:{api_key_secret}`.
x-mcp:
  enabled: true
x-provenance:
  method: harvested
  publisher: Higgsfield
  source: https://docs.higgsfield.ai/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)