🔄 Replicate API Integration Guide

⚡ If you need a specific model, please contact support to add it.

Replace the official endpoint https://api.replicate.com with {{BASE_URL}}/replicate.
👉 Input, output, and request methods remain identical to the official API.

📌 Integration Flow

Create a task → After submission, you will receive a Task ID.

Check task progress → Use the Task ID to query progress and retrieve results.

⚠️ Note: Returned resource links are only valid for 1 hour.

📊 Response Key Fields

Field	Type	Description
input	object	Input parameters
output	string / []string	Output content URL(s)
status	string	Task status: `starting` · `processing` · `succeeded` · `failed`

📝 Example 1: Create Task (Model Path Method)

Model: black-forest-labs/flux-schnell

Sample Response (with Task ID):

{
  "id": "qpt5jq1fssrmc0cmd5hvy31mdg",
  "model": "black-forest-labs/flux-schnell",
  "version": "dp-4d0bcc010b3049749a251855f12800be",
  "status": "starting",
  "output": null,
  "urls": {
    "cancel": "https://api.replicate.com/v1/predictions/qpt5jq1fssrmc0cmd5hvy31mdg/cancel",
    "get": "https://api.replicate.com/v1/predictions/qpt5jq1fssrmc0cmd5hvy31mdg",
    "stream": "https://stream.replicate.com/v1/files/..."
  }
}

📝 Example 2: Create Task (Version Method)

Model: lucataco/flux-schnell-lora
📖 Ref: Replicate Docs
Version: 2a6b576af31790b470f0a8442e1e9791213fa13799cbb65a9fc1436e96389574

Response format is the same as above.

📥 Retrieve Task Result

Use the Task ID to fetch results. The output is in the output field.
⚠️ Links are temporary!

Sample Response:

{
  "id": "ctdwaehfz1rm80cmd5nsjd8114",
  "model": "black-forest-labs/flux-schnell",
  "status": "succeeded",
  "output": [
    "https://replicate.delivery/xezq/RoEhEdyl8PoIGFFPg46TU4Svj24i1NDVYmzehJfqLuX9nTFUA/out-0.jpg"
  ],
  "metrics": {
    "image_count": 1,
    "predict_time": 0.5579
  }
}

Access Tutorial

🔄 Replicate API Integration Guide#

📌 Integration Flow#

📊 Response Key Fields#

📝 Example 1: Create Task (Model Path Method)#