Flows - Get flow definition

curl --request GET \
  --url https://api.magnific.com/v1/ai/flows/{flow-id} \
  --header 'x-magnific-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-magnific-api-key': '<api-key>'}};

fetch('https://api.magnific.com/v1/ai/flows/{flow-id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.magnific.com/v1/ai/flows/{flow-id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-magnific-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.magnific.com/v1/ai/flows/{flow-id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-magnific-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.magnific.com/v1/ai/flows/{flow-id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-magnific-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "sqid": "uqzQLDr2Aw",
    "name": "Sketch to Realism",
    "inputs": [
      {
        "id": "input-a1b2c3d4-e5f6-7890-abcd-ef1234567890-1",
        "api_key": "image",
        "key": "image",
        "type": "creation",
        "label": "Image",
        "config": {
          "mediaType": "image"
        },
        "nodeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "default": null,
        "required": true,
        "presentation": null
      }
    ],
    "tool_metadata": {
      "icon": "workflow",
      "description_key": null,
      "translation_key": null,
      "category": "general",
      "sort_order": 999,
      "total_cost": 5
    }
  }
}

Flows API

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

flows

{flow-id}

Flows - Get flow definition

curl --request GET \
  --url https://api.magnific.com/v1/ai/flows/{flow-id} \
  --header 'x-magnific-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-magnific-api-key': '<api-key>'}};

fetch('https://api.magnific.com/v1/ai/flows/{flow-id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.magnific.com/v1/ai/flows/{flow-id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-magnific-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.magnific.com/v1/ai/flows/{flow-id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-magnific-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.magnific.com/v1/ai/flows/{flow-id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-magnific-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "sqid": "uqzQLDr2Aw",
    "name": "Sketch to Realism",
    "inputs": [
      {
        "id": "input-a1b2c3d4-e5f6-7890-abcd-ef1234567890-1",
        "api_key": "image",
        "key": "image",
        "type": "creation",
        "label": "Image",
        "config": {
          "mediaType": "image"
        },
        "nodeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "default": null,
        "required": true,
        "presentation": null
      }
    ],
    "tool_metadata": {
      "icon": "workflow",
      "description_key": null,
      "translation_key": null,
      "category": "general",
      "sort_order": 999,
      "total_cost": 5
    }
  }
}

Authorizations

x-magnific-api-key

string

header

required

Your Magnific API key. Required for authentication. Learn how to obtain an API key

Path Parameters

flow-id

string

required

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

Example:

"uqzQLDr2Aw"

Response

OK - Flow definition with inputs and cost.

data

object

required

Full definition of a flow including dynamic inputs and cost.

Show child attributes

Example:

{
  "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"
}

Flows - List my flows

Flows - Run a flow

⌘I

Get started

APIs

Flows - Get flow definition

Authorizations

Path Parameters

Response