Start Inference Job

Start a new batch inference job.

Recipes
😀
Facial Expression with the Batch API
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Polling the API periodically for job status is NOT recommended long term. Rather, provide a callback url to use webhooks to asynchronously receive notifications once the job completes.

Body Params
models
object

If this field is not explicitly set, then all models will be run by default.

transcription
object

To disable transcription, explicitly set this field to null.

urls
array of urls
length ≤ 100
Defaults to []

URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (.zip, .tar.gz, .tar.bz2, .tar.xz) of media files.

If you wish to supply more than 100 URLs, consider providing them as an archive (.zip, .tar.gz, .tar.bz2, .tar.xz).

urls
text
array of strings
length ≤ 100
Defaults to []

Text to supply directly to our language and NER models.

text
url

If provided, a POST request will be made to the URL with the generated predictions on completion or the error message on failure.

boolean
Defaults to false

Whether to send an email notification to the user upon job completion/failure.

Headers
string
enum
Defaults to application/json; charset=utf-8

Generated from available request content types

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8