Grok Imagine خريطة التجزئة

01

نظرة عامة

استخدم نقطة نهاية خريطة التجزئة مع نموذج مدعوم. استخدم معرّف المهمة المُعاد لاسترداد حالتها، أو أدخل callback_url للتسليمات الموثقة أدناه.

البدء السريع

أنشئ مفتاح API واضبطه كـ RUNAPI_API_KEY.
اختر نموذجاً مدعوماً وأرسل طلب POST يطابق مخطط ذلك النموذج.
احفظ معرّف المهمة المُعاد، ثم استطلع الحالة حتى تبلغ حالة نهائية أو تعالج عمليات الاستدعاء الموثقة أدناه.

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

مخطط الطلب

نص JSON

تعتمد الحقول والقيم المسموح بها على النموذج المحدد. عند التوفير، يستقبل callback_url عمليات تسليم المهمة الموثّقة أدناه.

grok-imagine-image-2-04 حقل

callback_urlstring

اختياري

رابط Webhook لتسليم المهمة عند اكتمالها.

image_urlstring

اختياري

عنوان URL عام للصورة يمكن للخدمة جلبه.

modelstring

مطلوب

معرّف النموذج.

source_task_idstring

اختياري

معرّف مهمة تحويل النص إلى صورة المكتملة في Image 2.0 المملوكة لنفس الحساب. مدخل توافقي؛ استخدم image_url بدلاً منه.

القواعد الشرطية

تسري هذه المتطلبات عندما تتطابق جميع الشروط المدرجة.

عندما

مطلوب

غير مقبول
عندما image_url = {"present" => true}

مطلوب

غير مقبول

source_task_id
عندما source_task_id = {"present" => true}

مطلوب

غير مقبول

image_url

04

إنشاء قبول

HTTP 202

POST /api/v1/grok_imagine/segment_map

مخطط الاستجابة

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

مخطط الاستجابة

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

مخطط الاستجابة

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

مخطط الاستجابة

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

مخطط الاستجابة

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

مخطط الاستجابة

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

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

JSON

{
  "error": "Authentication required"
}

11

الأخطاء

HTTP 401

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

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

JSON

{
  "error": "Authentication required"
}

12

الأخطاء

HTTP 400

POST /api/v1/grok_imagine/segment_map

مخطط الاستجابة

JSON

{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "رسالة خطأ قابلة للقراءة البشرية.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "ملخص التحقق القابل للقراءة البشرية.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "رسائل التحقق مفتاحها حقل الطلب العام، مع مصفوفة من السلاسل القابلة للقراءة البشرية لكل حقل.",
          "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

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

JSON

{
  "error": "Insufficient balance"
}

14

الأخطاء

HTTP 429

POST /api/v1/grok_imagine/segment_map

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "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

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "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

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "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

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "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

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "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

مخطط الاستجابة

JSON

{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "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 خريطة التجزئة

نظرة عامة

البدء السريع

نقطة النهاية

النماذج المدعومة

مخطط الطلب

القواعد الشرطية

إنشاء قبول

مثال على الاستجابة

الاستطلاع قيد المعالجة

مثال على الاستجابة

اكتمل الاستطلاع

مثال على الاستجابة

فشل الاستطلاع

مثال على الاستجابة

استدعاء العميل: مكتمل

مثال على الاستجابة

استدعاء العميل: فشل

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

الأخطاء

مثال على الاستجابة

نماذج الأكواد المولَّدة

التثبيت

الأدلة ذات الصلة