replicate-api

A typed client library for the replicate.com API.

You can use this to access the prediction API in a type-safe and convenient way.

Install

Just install it with your favourite package manager:

yarn add replicate-api
pnpm add replicate-api
npm install replicate-api

The package should work in the browser and in Node.js versions 18 and up *.

Obtain a API token

You need an API token for nearly all operations. You can find the token in your account settings.

Examples

Generate an image with stable-diffusion

You can create a new prediction using the stability-ai/stable-diffusion model and wait for the result with:

const prediction = await predict({
  model: "stability-ai/stable-diffusion", // The model name
  input: { prompt: "multicolor hyperspace" }, // The model specific input
  token: "...", // You need a token from replicate.com
  poll: true, // Wait for the model to finish
})

console.log(prediction.outputs[0])
// https://replicate.com/api/models/stability-ai/stable-diffusion/files/58a1dcfc-3d5d-4297-bac2-5395294fe463/out-0.png

This does some things for you like resolving the model name to a model version and polling until the prediction is completed.

Create a new prediction

const result = await predict({ model: "replicate/hello-world", input: { prompt: "..." }, token: "..." })

Then you can check result.status to see if it's "starting", "processing" or succeeded. If it's "succeeded" you can get the outputs with result.outputs. If not you can check back later with getPrediction and the id from result (result.id).

You can also use pollPrediction to poll until the prediction is done.

Retrieve the result of a prediction

const result = await getPrediction({ id, token: "..." })

Cancel a running prediction

await cancelPrediction({ id, token: "..." })

Get information about a model

await getModel({ id, token: "..." })

Generate an image with stable-diffusion

The first example used a few convenience functions to make it easier to use the API. You can also use the lower level functions that map the API calls more directly.

const model = await getModel({ id, token: "..." })

let prediction = await predict({
  version: model.version,
  input: { prompt: "multicolor hyperspace" },
  token: "...",
})

// pollPrediction does this a bit smarter, with increasing backoff
while (prediction.status === "starting" || prediction.status === "processing") {
  await new Promise(resolve => setTimeout(resolve, 1000))
  prediction = await getPrediction({ id: prediction.id, token: "..." })
}

console.log(prediction.outputs[0])
// https://replicate.com/api/models/stability-ai/stable-diffusion/files/58a1dcfc-3d5d-4297-bac2-5395294fe463/out-0.png

Related projects

• replicate-js - A js object oriented client for replicate

Older node versions

This package uses the fetch API which is only supported in Node.js 18 and up. If you need to use an older version of node, you can probably use node-fetch but I have not tested it. It should be enough to just have node-fetch installed. The Options object supports passing a custom fetch function, you can also try to pass node-fetch there.