feat: update types to match OpenAPI schema by zeke · Pull Request #363 · replicate/replicate-javascript

zeke · 2025-10-17T16:58:46Z

This PR updates TypeScript types to match the OpenAPI schema from https://api.replicate.com/openapi.json

Changes

Account

Add avatar_url?: string field

Status

Remove "aborted" status (not in OpenAPI schema)
Now: "starting" | "processing" | "succeeded" | "failed" | "canceled"

FileObject

Remove name: string field
Remove etag: string field
Change checksum: string to checksums: { sha256: string }

Prediction

Change version: string to version: string | "hidden" (for official models)
Add data_removed: boolean field
Add deadline?: string field
Add deployment?: string field
Change metrics.predict_time to metrics.total_time
Add urls.web?: string field

Training

Change from type alias type Training = Prediction to a full interface
Add proper output?: { version?: string; weights?: string } structure
Different metrics: both predict_time and total_time
URLs only include get and cancel (no stream or web)

ModelVersion

Change cog_version: string to cog_version: string | null
Change openapi_schema: object to openapi_schema: object | null

Testing locally

gh repo clone replicate/replicate-javascript
cd replicate-javascript
gh pr checkout <PR_NUMBER>
npm install
npm run check
npm run lint
npm test

Prompts

Update the types to correspond to the OpenAPI schema: https://api.replicate.com/openapi.json

This PR updates TypeScript types to match the OpenAPI schema from https://api.replicate.com/openapi.json Changes: - Account: add avatar_url field - Status: remove "aborted" status (not in OpenAPI schema) - FileObject: replace name, etag, checksum with checksums object - Prediction: add data_removed, deadline, deployment fields; change version to support "hidden"; update metrics to use total_time; add web URL - Training: convert from type alias to full interface with proper output structure - ModelVersion: make cog_version and openapi_schema nullable

superhighfives · 2025-10-21T20:56:24Z

index.d.ts

@@ -1,5 +1,5 @@
 declare module "replicate" {
-  type Status = "starting" | "processing" | "succeeded" | "failed" | "canceled" | "aborted";


Are we still using aborted, @erbridge? Just noticed it because we were discussing statuses today.

Looks like it's defined and used in replicate/api, but not yet documented in the OpenAPI schema.

We are using it, so we should probably update the schema.

PR: https://github.com/replicate/api/pull/2069

☝🏼 Shipped.

Updated this PR: d702154

Per the OpenAPI schema, both predictions and trainings can have an "aborted" status, which indicates the task was terminated before it started running (e.g., when a deadline is reached before execution begins).

zeke · 2025-10-22T23:09:06Z

This is ready for another look.

superhighfives · 2025-10-23T17:38:40Z

index.d.ts

    };
  }

-  export type Training = Prediction;


@zeke Do we want to move to training being a standalone type? Currently it mirrors Prediction, so I'm not sure what this will do, if anything, to linting.

Training and Prediction have different fields according to the OpenAPI schema, so I think they should be separate types:

Fields in Prediction but NOT in Training:

data_removed: boolean

deadline?: string

deployment?: string

Type differences:

version: Prediction is string | "hidden", Training is just string

output: Prediction is any, Training is { version?: string; weights?: string }

urls: Prediction has stream?, Training does not

Maybe these are also just inconsistencies between Training and Prediction in the OpenAPI schema, but I don't actually know.

Yeah, fair! I'm not sure. 😔 I wouldn't be surprised if there were inconsistencies there. Good to clean it up.

superhighfives

Left a comment, but looking good!

Per the OpenAPI schema, Training objects include a web URL in their urls object, matching the Prediction interface.

zeke · 2025-10-24T17:00:35Z

Released: https://github.com/replicate/replicate-javascript/releases/tag/v1.3.1

zeke added 2 commits October 17, 2025 09:58

fix: keep predict_time in Prediction metrics for backward compatibility

bf708b6

zeke requested a review from superhighfives October 21, 2025 16:21

superhighfives reviewed Oct 21, 2025

View reviewed changes

feat: add "aborted" status to Status type

d702154

Per the OpenAPI schema, both predictions and trainings can have an "aborted" status, which indicates the task was terminated before it started running (e.g., when a deadline is reached before execution begins).

zeke requested review from erbridge and superhighfives October 22, 2025 23:08

superhighfives reviewed Oct 23, 2025

View reviewed changes

fix: add web URL to Training.urls

bfd6b84

Per the OpenAPI schema, Training objects include a web URL in their urls object, matching the Prediction interface.

zeke requested a review from superhighfives October 24, 2025 16:07

zeke merged commit 6124a0e into main Oct 24, 2025
20 checks passed

zeke deleted the feat/update-types-to-openapi-schema branch October 24, 2025 16:53

		@@ -1,5 +1,5 @@
		declare module "replicate" {
		type Status = "starting" \| "processing" \| "succeeded" \| "failed" \| "canceled" \| "aborted";

Conversation

zeke commented Oct 17, 2025

Changes

Account

Status

FileObject

Prediction

Training

ModelVersion

Testing locally

Prompts

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zeke Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zeke commented Oct 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

superhighfives left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zeke commented Oct 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zeke Oct 22, 2025 •

edited

Loading