Grok Imagine Segment-Map

01

概览

使用支持的模型提交Segment Map请求。使用返回的 Task ID 查询状态，或提供 callback_url 接收下方列出的投递。

快速开始

创建 API Key，并将其设置为 RUNAPI_API_KEY。
选择一个支持的模型，并发送与该模型 Schema 匹配的 POST 请求。
保存返回的任务 ID，随后轮询到终态，或处理下方列出的回调。

POST /api/v1/grok_imagine/segment_map

基础 URL: https://runapi.ai
API 版本: v1
身份验证: Authorization: Bearer YOUR_API_TOKEN

02

支持的模型

打开模型页可查看当前价格、限流和商业使用详情。

grok-imagine-image-2-0

03

请求 Schema

JSON 请求体

字段和允许的取值取决于所选模型。提供 callback_url 后，它会收到下方列出的 Task 投递。

grok-imagine-image-2-04 个字段

callback_urlstring

可选

Webhook URL for terminal Task delivery.

image_urlstring

可选

Public image URL that the service can fetch.

modelstring

必填

Model slug.

source_task_idstring

可选

Completed Image 2.0 text-to-image Task ID owned by the same account. Compatibility input; use image_url instead.

条件规则

当列出的全部条件同时匹配时，应用这些要求。

当

必填

不可提供
当 image_url = {"present" => true}

必填

不可提供

source_task_id
当 source_task_id = {"present" => true}

必填

不可提供

image_url

04

创建已接受

HTTP 202

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    },
    "task_replayed": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "status",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "processing"
}

05

轮询处理中

HTTP 200

GET /api/v1/grok_imagine/segment_map/:id

响应 Schema

JSON

{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "processing"
}

06

轮询已完成

HTTP 200

GET /api/v1/grok_imagine/segment_map/:id

响应 Schema

JSON

{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "segments": {
      "items": {
        "properties": {
          "index": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "segments",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "segments": [
    {
      "index": 1,
      "name": "subject",
      "url": "https://file.runapi.ai/reference-segment.png"
    }
  ],
  "status": "completed"
}

07

轮询失败

HTTP 200

GET /api/v1/grok_imagine/segment_map/:id

响应 Schema

JSON

{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "error": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "error": "Task processing failed.",
  "id": "tsk_reference_demo",
  "status": "failed"
}

08

客户回调：已完成

HTTP 200

POST callback_url

响应 Schema

JSON

{
  "properties": {
    "id": {
      "type": "string"
    },
    "segments": {
      "items": {
        "properties": {
          "index": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "segments"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "id": "tsk_reference_demo",
  "segments": [
    {
      "index": 1,
      "name": "subject",
      "url": "https://file.runapi.ai/reference-segment.png"
    }
  ],
  "status": "completed"
}

09

客户回调：失败

HTTP 200

POST callback_url

响应 Schema

JSON

{
  "properties": {
    "error": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "properties": {
            "code": {
              "type": "string"
            },
            "limit_cents": {
              "type": "integer"
            },
            "message": {
              "type": "string"
            },
            "reset_at": {
              "format": "date-time",
              "type": [
                "string",
                "null"
              ]
            },
            "used_cents": {
              "type": "integer"
            },
            "window": {
              "enum": [
                "1h",
                "1d",
                "7d",
                "daily",
                "weekly",
                "monthly",
                "lifetime"
              ],
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object",
          "unevaluatedProperties": false
        }
      ]
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": {
    "code": "generation_failed",
    "message": "Task processing failed."
  },
  "id": "tsk_reference_demo",
  "status": "failed"
}

10

错误

HTTP 401

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "Authentication required"
}

11

错误

HTTP 401

GET /api/v1/grok_imagine/segment_map/:id

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "Authentication required"
}

12

错误

HTTP 400

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Human-readable error message.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Human-readable validation summary.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validation messages keyed by public request field, with an array of human-readable strings for each field.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

响应示例

JSON

{
  "error": "model must be one of: grok-imagine-image-2-0"
}

13

错误

HTTP 402

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "Insufficient balance"
}

14

错误

HTTP 429

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "API key credit limit exceeded"
}

15

错误

HTTP 409

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "The request uses features that are not supported for the selected model"
}

16

错误

HTTP 429

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "Rate limit reached. Please retry later."
}

17

错误

HTTP 503

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "Service under maintenance, please try again later"
}

18

错误

HTTP 504

POST /api/v1/grok_imagine/segment_map

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "The request timed out"
}

19

错误

HTTP 404

GET /api/v1/grok_imagine/segment_map/:id

响应 Schema

JSON

{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON

{
  "error": "Task with id 'tsk_reference_demo' not found"
}

20

生成的代码示例

直接使用 cURL，或安装所用语言的 SDK。每个示例都会提交本参考中经过验证的请求。

安装

Shell

pip install runapi-grok-imagine

PYTHON

import os
from runapi.grok_imagine import GrokImagineClient

client = GrokImagineClient(api_key=os.environ["RUNAPI_API_KEY"])
task = client.segment_map.create(
  model="grok-imagine-image-2-0",
  image_url="https://cdn.runapi.ai/public/samples/image.jpg"
)

安装

Shell

npm install @runapi.ai/grok-imagine

JAVASCRIPT

import { GrokImagineClient } from "@runapi.ai/grok-imagine";

const client = new GrokImagineClient({ apiKey: process.env.RUNAPI_API_KEY });
const task = await client.segmentMap.create({
  "model": "grok-imagine-image-2-0",
  "image_url": "https://cdn.runapi.ai/public/samples/image.jpg"
});

CURL

curl -X POST https://runapi.ai/api/v1/grok_imagine/segment_map \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"model":"grok-imagine-image-2-0","image_url":"https://cdn.runapi.ai/public/samples/image.jpg"}'

安装

Shell

go get github.com/runapi-ai/grok-imagine-sdk/go@latest

GO

package main

import (
  "context"
  "log"
  "os"

  "github.com/runapi-ai/core-sdk/go/option"
  grokimagine "github.com/runapi-ai/grok-imagine-sdk/go/grokimagine"
)

func main() {
  client, err := grokimagine.NewClient(option.WithAPIKey(os.Getenv("RUNAPI_API_KEY")))
  if err != nil {
    log.Fatal(err)
  }

  task, err := client.SegmentMap.Create(context.Background(), grokimagine.SegmentMapParams{
    Model: grokimagine.SegmentMapModel("grok-imagine-image-2-0"),
    ImageURL: "https://cdn.runapi.ai/public/samples/image.jpg",
  })
  if err != nil {
    log.Fatal(err)
  }
  _ = task
}

21

Grok Imagine Segment-Map

概览

快速开始

端点

支持的模型

请求 Schema

条件规则

创建已接受

响应示例

轮询处理中

响应示例

轮询已完成

响应示例

轮询失败

响应示例

客户回调：已完成

响应示例

客户回调：失败

响应示例

错误

响应示例

错误

响应示例

错误

响应示例

错误

响应示例

错误

响应示例

错误

响应示例

错误

响应示例

错误

响应示例

错误

响应示例

错误

响应示例

生成的代码示例

安装

相关指南