Huggingface.js

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

Interface: BaseArgs

• Optional accessToken: string

The access token to use. Without it, you’ll get rate-limited quickly.

Can be created for free in hf.co/settings/token

• Optional endpointUrl: string

The URL of the endpoint to use. If not specified, will call huggingface.co/api/tasks to get the default endpoint for the task.

If specified, will use this URL instead of the default one.

• Optional model: string

The model to use.

If not specified, will call huggingface.co/api/tasks to get the default model for the task.

/!\ Legacy behavior allows this to be an URL, but this is deprecated and will be removed in the future. Use the endpointUrl parameter instead.