Skip to content

Commit abe1029

Browse files
authored
document wait option for *.prediction.create() methods (#319)
1 parent a7dfbfd commit abe1029

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -618,6 +618,7 @@ const response = await replicate.predictions.create(options);
618618
| `options.input` | object | **Required**. An object with the model's inputs |
619619
| `options.model` | string | The name of the model, e.g. `black-forest-labs/flux-schnell`. This is required if you're running an [official model](https://replicate.com/explore#official-models). |
620620
| `options.version` | string | The 64-character [model version id](https://replicate.com/docs/topics/models/versions), e.g. `80537f9eead1a5bfa72d5ac6ea6414379be41d4d4f6679fd776e9535d1eb58bb`. This is required if you're not specifying a `model`. |
621+
| `options.wait` | number | Wait up to 60s for the prediction to finish before returning. Disabled by default. See [Synchronous predictions](https://replicate.com/docs/topics/predictions/create-a-prediction#sync-mode) for more information. |
621622
| `options.stream` | boolean | Requests a URL for streaming output output |
622623
| `options.webhook` | string | An HTTPS URL for receiving a webhook when the prediction has new output |
623624
| `options.webhook_events_filter` | string[] | You can change which events trigger webhook requests by specifying webhook events (`start` \| `output` \| `logs` \| `completed`) |

0 commit comments

Comments
 (0)