Integration Tutorial

Replicate Official Format API Calls

| If you need a model added, please contact customer support

Replace the official https://api.replicate.com with {{BASE_URL}}/replicate
The input, output, and request methods are identical to the official API.

Integration Flow

Create a task
After submitting the task, you will receive a task ID.

Get task progress
Query task progress using the task ID to retrieve the result.

PS: The returned resource links are only valid for 1 hour.

Response Body — Key Field Descriptions

Field	Type	Description
input	object	Input
output	string or []string	Content output URL
status	string	Status — `starting` `processing` `succeeded` `failed`

Create Task — Path Method
Using black-forest-labs/flux-schnell as an example:

The id field in the response body is the task ID used for the next query step.

{
  "id": "qpt5jq1fssrmc0cmd5hvy31mdg",
  "model": "black-forest-labs/flux-schnell",
  "version": "dp-4d0bcc010b3049749a251855f12800be",
  "input": {
    "aspect_ratio": "1:1",
    "go_fast": true,
    "megapixels": "1",
    "num_inference_steps": 4,
    "num_outputs": 1,
    "output_format": "jpg",
    "output_quality": 80,
    "prompt": "Japanese cartoon anime style, (1 person) (Gender: Male, Age: 30, Hair: Short black hair, Outfit: Dark blue hunting attire, includes a fitted jacket and trousers.) (A dimly lit room filled with tension,  is questioning Female, 27 years old, long black hair, pink tulle dress., who stands nervously in her pink dress, the sound of rain pattering against the window.)"
  },
  "logs": "",
  "output": null,
  "data_removed": false,
  "error": null,
  "status": "starting",
  "created_at": "2025-01-15T09:54:55.566Z",
  "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/bcwr-gvuc2rokjozhlaxh6dcvk6tvhh2ymt4egnnpxvmtqql57angyfsq"
  }
}

Create Task — Version Method
Using lucataco/flux-schnell-lora as an example:
Reference documentation: https://replicate.com/lucataco/flux-schnell-lora?input=http
From the reference documentation, the version is 2a6b576af31790b470f0a8442e1e9791213fa13799cbb65a9fc1436e96389574

The response body format is the same as above.

Get Task Result
Use the task ID obtained from the task creation above.
The result is found in the key field output.
Note: Both the returned results and the linked files have an expiration time.
get {{BASE_URL}}/replicate/v1/predictions/{id}

Response Body:

{
  "id": "ctdwaehfz1rm80cmd5nsjd8114",
  "model": "black-forest-labs/flux-schnell",
  "version": "dp-4d0bcc010b3049749a251855f12800be",
  "input": {
    "aspect_ratio": "1:1",
    "go_fast": true,
    "megapixels": "1",
    "num_inference_steps": 4,
    "num_outputs": 1,
    "output_format": "jpg",
    "output_quality": 80,
    "prompt": "Japanese cartoon anime style, (1 person) (Gender: Male, Age: 30, Hair: Short black hair, Outfit: Dark blue hunting attire, includes a fitted jacket and trousers.) (A dimly lit room filled with tension,  is questioning Female, 27 years old, long black hair, pink tulle dress., who stands nervously in her pink dress, the sound of rain pattering against the window.)"
  },
  "logs": "Using seed: 62182
running quantized prediction
Using seed: 62182
  0%|          | 0/4 [00:00<?, ?it/s]
 75%|███████▌  | 3/4 [00:00<00:00, 15.38it/s]
100%|██████████| 4/4 [00:00<00:00, 13.43it/s]
Total safe images: 1 out of 1
",
  "output": [
    "https://replicate.delivery/xezq/RoEhEdyl8PoIGFFPg46TU4Svj24i1NDVYmzehJfqLuX9nTFUA/out-0.jpg"
  ],
  "data_removed": false,
  "error": null,
  "status": "succeeded",
  "created_at": "2025-01-15T10:03:39.896Z",
  "started_at": "2025-01-15T10:03:40.584470194Z",
  "completed_at": "2025-01-15T10:03:41.142386377Z",
  "urls": {
    "cancel": "https://api.replicate.com/v1/predictions/ctdwaehfz1rm80cmd5nsjd8114/cancel",
    "get": "https://api.replicate.com/v1/predictions/ctdwaehfz1rm80cmd5nsjd8114",
    "stream": "https://stream.replicate.com/v1/files/bcwr-q57vie7wuzg3wxv2hvpajgmzqzmxe67kqddednevutmrpdcft6xq"
  },
  "metrics": {
    "image_count": 1,
    "predict_time": 0.557916184
  }
}

Replicate Official Format API Calls#

Replicate Official Format API Calls