inference-endpoints/pr_113/en/api_reference.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;API Reference (Swagger)&quot;,&quot;local&quot;:&quot;api-reference-swagger&quot;,&quot;sections&quot;:[],&quot;depth&quot;:1}">
		<link href="/docs/inference-endpoints/pr_113/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/entry/start.d1c14968.js">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/scheduler.389d799c.js">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/singletons.16c9b508.js">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/paths.58d119e0.js">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/entry/app.18050d92.js">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/index.8f81d18f.js">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/nodes/0.ce016c16.js">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/nodes/2.27156348.js">
		<link rel="modulepreload" href="/docs/inference-endpoints/pr_113/en/_app/immutable/chunks/getInferenceSnippets.8efa8e08.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;API Reference (Swagger)&quot;,&quot;local&quot;:&quot;api-reference-swagger&quot;,&quot;sections&quot;:[],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>  <h1 class="relative group"><a id="api-reference-swagger" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#api-reference-swagger"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>API Reference (Swagger)</span></h1> <p data-svelte-h="svelte-55wsmq">🤗 Inference Endpoints can be used through the <a href="https://ui.endpoints.huggingface.co/endpoints" rel="nofollow">UI</a> and programmatically through an API.
The API exposes <a href="https://api.endpoints.huggingface.cloud/" rel="nofollow">open-API specification</a> for each available route.</p> <iframe src="https://api.endpoints.huggingface.cloud/" style="height: 60vh; width: 100%;" frameborder="0" id="iframe" data-svelte-h="svelte-17lkzlc">Browser not compatible.</iframe> <p data-svelte-h="svelte-23vtof">Update May 2024: We have renamed instances and further details can be found in the <a href="https://huggingface.co/docs/inference-endpoints/pricing" rel="nofollow">pricing documentation</a>. For example, when using 1x A10G instance, the naming is:</p> <ul data-svelte-h="svelte-1fx0lbf"><li>instance_type: nvidia-a10g</li> <li>instance_size: x1</li></ul> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/hf-endpoints-documentation/blob/main/docs/source/api_reference.mdx" target="_blank"><span data-svelte-h="svelte-1kd6by1">&lt;</span> <span data-svelte-h="svelte-x0xyl0">&gt;</span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a>  <p></p> 
			
			<script>
				{
					__sveltekit_87vzq7 = {
						assets: "/docs/inference-endpoints/pr_113/en",
						base: "/docs/inference-endpoints/pr_113/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/inference-endpoints/pr_113/en/_app/immutable/entry/start.d1c14968.js"),
						import("/docs/inference-endpoints/pr_113/en/_app/immutable/entry/app.18050d92.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 2],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>