Skip to main content
GET
/
v1
/
ai
/
apps
/
{app-id}
Apps - Get workflow app definition
curl --request GET \
  --url https://api.magnific.com/v1/ai/apps/{app-id} \
  --header 'x-magnific-api-key: <api-key>'
{
  "data": {
    "sqid": "uqzQLDr2Aw",
    "name": "Sketch to Realism",
    "inputs": [
      {
        "id": "input-a1b2c3d4-e5f6-7890-abcd-ef1234567890-1",
        "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

​
app-id
string
required

Short unique identifier (sqid) of the workflow app. Discover app identifiers via GET /v1/ai/apps.

Example:

"uqzQLDr2Aw"

Response

OK - Workflow app definition with inputs and cost.

​
data
object
required

Full definition of a workflow app including dynamic inputs and cost.

Example:
{
  "inputs": [
    {
      "presentation": { "mode": "textarea", "type": "text" },
      "default": "",
      "id": "input-4050c3f3-8a26-4953-97a8-cb97bceb4816-1",
      "label": "Text #1",
      "type": "text",
      "config": { "mediaType": "image" },
      "nodeId": "4050c3f3-8a26-4953-97a8-cb97bceb4816",
      "key": "text",
      "required": true
    },
    {
      "presentation": { "mode": "textarea", "type": "text" },
      "default": "",
      "id": "input-4050c3f3-8a26-4953-97a8-cb97bceb4816-1",
      "label": "Text #1",
      "type": "text",
      "config": { "mediaType": "image" },
      "nodeId": "4050c3f3-8a26-4953-97a8-cb97bceb4816",
      "key": "text",
      "required": true
    }
  ],
  "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"
}