replicate-javascript

Instead of polling for results, you can use Webhooks to receive HTTP POST requests from Replicate when a prediction's status changes.

To use webhooks:

1. Provide a webhook URL in replicate.predictions.create.
2. Specify which events to receive using webhook_events_filter. Supported values are: "start", "output", "logs", and "completed".

Example setup with a webhook URL:

await replicate.predictions.create({
  version: "...",
  input: { ... },
  webhook: "https://my.app/webhooks/replicate",
  webhook_events_filter: ["completed"],
});

const Replicate = require("replicate");
const replicate = new Replicate();

const input = {
    image: "https://replicate.delivery/pbxt/KWDkejqLfER3jrroDTUsSvBWFaHtapPxfg4xxZIqYmfh3zXm/Screenshot%202024-02-28%20at%2022.14.00.png",
    denoising_strength: 0.5,
    instant_id_strength: 0.8
};

const callbackURL = `https://my.app/webhooks/replicate`;
await replicate.predictions.create({
  version: "19deaef633fd44776c82edf39fd60e95a7250b8ececf11a725229dc75a81f9ca",
  input: input,
  webhook: callbackURL,
  webhook_events_filter: ["completed"],
});

The library provides full TypeScript definitions. You can import types like Prediction directly from the package.

Requirement: To support the module format, you must set "esModuleInterop": true in your tsconfig.json.

import Replicate, { type Prediction } from 'replicate';

const replicate = new Replicate();
const model = "black-forest-labs/flux-schnell";

function onProgress(prediction: Prediction) { 
  console.log({ prediction });
}

const output = await replicate.run(model, { input: { prompt: "..." } }, onProgress);

import Replicate, { type Prediction } from 'replicate';

const replicate = new Replicate();
const model = "black-forest-labs/flux-schnell";
const prompt = "a 19th century portrait of a raccoon gentleman wearing a suit";

function onProgress(prediction: Prediction) {
  console.log({ prediction });
}

const output = await replicate.run(model, { input: { prompt } }, onProgress)
console.log({ output })

If options.stream is set to true during prediction creation, the returned prediction object will contain a urls.stream property. You can use this URL with the EventSource API to listen for real-time updates.

Event Types:

• output (plain text): Emitted when the prediction returns new output.
• error (JSON): Emitted when the prediction returns an error.
• done (JSON): Emitted when the prediction finishes (successfully, via cancellation, or via error).

if (prediction && prediction.urls && prediction.urls.stream) {
  const source = new EventSource(prediction.urls.stream, { withCredentials: true });

  source.addEventListener("output", (e) => {
    console.log("output", e.data);
  });

  source.addEventListener("error", (e) => {
    console.error("error", JSON.parse(e.data));
  });

  source.addEventListener("done", (e) => {
    source.close();
    console.log("done", JSON.parse(e.data));
  });
}

To interact with the Replicate API, create a new instance of the Replicate class. You can provide an API token via the auth option or by setting the REPLICATE_API_TOKEN environment variable.

Configuration Options

• auth (string): API access token. Defaults to process.env.REPLICATE_API_TOKEN.
• userAgent (string): Identifier of your app.
• baseUrl (string): Defaults to https://api.replicate.com/v1.
• fetch (Function): Custom fetch function. Defaults to globalThis.fetch.
• useFileOutput (boolean): If false, run returns URLs instead of FileOutput objects. Defaults to true.
• fileEncodingStrategy (string): Determines the file encoding strategy. Options: "default", "upload", or "data-uri".

const Replicate = require("replicate");

const replicate = new Replicate({
    // get your token from https://replicate.com/account
    auth: process.env.REPLICATE_API_TOKEN,
    userAgent: "my-app/1.2.3"
});