flows

Flows - Get flow definition

Returns the full definition of a flow, including its dynamic inputs and cost.

Inputs define what values the caller must provide when running the flow:

  • creation type: accepts an image/media URL, base64-encoded data, or an existing creation identifier
  • text type: accepts a plain text string (prompt, label, etc.)
  • number type: accepts a numeric value
  • select type: accepts a value from predefined options

Use each input's api_key field (recommended, human-friendly node name) as the identifier when calling the run endpoint. The UUID-based id field is still accepted for backward compatibility. The tool_metadata.total_cost field indicates the credit cost per execution.

get/v1/ai/flows/{flow-id}

Request

  • Base URL: https://api.magnific.com
  • URL: https://api.magnific.com/v1/ai/flows/{flow-id}
  • Auth: API key in header x-magnific-api-key

Path parameters

flow-idstring required
Example:uqzQLDr2Aw

Short unique identifier (sqid) of the flow. Discover flow identifiers via GET /v1/ai/flows.

Response

OK - Flow definition with inputs and cost.

Example response

{
  "data": {
    "inputs": [
      {
        "id": "input-4050c3f3-8a26-4953-97a8-cb97bceb4816-1",
        "api_key": "text_prompt",
        "key": "text_prompt",
        "type": "text",
        "label": "Text #1",
        "config": null,
        "nodeId": "4050c3f3-8a26-4953-97a8-cb97bceb4816",
        "default": null,
        "required": true,
        "presentation": {
          "mode": "textarea",
          "type": "text"
        }
      },
      {
        "id": "input-4050c3f3-8a26-4953-97a8-cb97bceb4816-1",
        "api_key": "text_prompt",
        "key": "text_prompt",
        "type": "text",
        "label": "Text #1",
        "config": null,
        "nodeId": "4050c3f3-8a26-4953-97a8-cb97bceb4816",
        "default": null,
        "required": true,
        "presentation": {
          "mode": "textarea",
          "type": "text"
        }
      }
    ],
    "name": "Sketch to Realism",
    "tool_metadata": {
      "total_cost": 5,
      "icon": "workflow",
      "translation_key": "translation_key",
      "description_key": "description_key",
      "category": "general",
      "sort_order": 999
    },
    "sqid": "uqzQLDr2Aw"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.