first draft

Author: Wauplin

docs/api-inference/_toctree.yml

@@ -1,27 +1,37 @@
-- sections:
+- title: Get Started
+  sections:
   - local: index
-    title: Serverless Inference API
-  - local: getting-started
-    title: Getting Started
-  - local: supported-models
-    title: Supported Models
+    title: Inference Providers API
   - local: pricing
-    title: Pricing and Rate limits
+    title: Pricing and Billing
+  - local: hub-integration
+    title: Hub integration
+  - local: providers
+    title: Providers
   - local: security
     title: Security
-  title: Getting Started
-- sections:
-  - local: parameters
-    title: Parameters
-  - sections:
-    - local: tasks/audio-classification
-      title: Audio Classification
-    - local: tasks/automatic-speech-recognition
-      title: Automatic Speech Recognition
+- title: API Reference
+  sections:
+  - local: tasks/index
+    title: Index
+  - local: hub-api
+    title: Hub API
+  - title: Popular Tasks
+    sections:
     - local: tasks/chat-completion
       title: Chat Completion
     - local: tasks/feature-extraction
       title: Feature Extraction
+    - local: tasks/text-generation
+      title: Text Generation
+    - local: tasks/text-to-image
+      title: Text to Image
+  - title: Other Tasks
+    sections:
+    - local: tasks/audio-classification
+      title: Audio Classification
+    - local: tasks/automatic-speech-recognition
+      title: Automatic Speech Recognition
     - local: tasks/fill-mask
       title: Fill Mask
     - local: tasks/image-classification
@@ -30,8 +40,6 @@
       title: Image Segmentation
     - local: tasks/image-to-image
       title: Image to Image
-    - local: tasks/image-text-to-text
-      title: Image-Text to Text
     - local: tasks/object-detection
       title: Object Detection
     - local: tasks/question-answering
@@ -42,15 +50,9 @@
       title: Table Question Answering
     - local: tasks/text-classification
       title: Text Classification
-    - local: tasks/text-generation
-      title: Text Generation
-    - local: tasks/text-to-image
-      title: Text to Image
     - local: tasks/token-classification
       title: Token Classification
     - local: tasks/translation
       title: Translation
     - local: tasks/zero-shot-classification
-      title: Zero Shot Classification
-    title: Detailed Task Parameters
-  title: API Reference
+      title: Zero Shot Classification

docs/api-inference/getting-started.md

@@ -0,0 +1,9 @@
+# Hub API
+
+**TODO**
+- search for models (API): https://huggingface.co/api/models?inference_provider=fireworks-ai
+- get warm models (any provider): https://huggingface.co/api/models?inference=warm
+- get warm status for a model: https://huggingface.co/api/models/google/gemma-3-27b-it?expand[]=inference
+- get providers for a model: https://huggingface.co/api/models/Qwen/QwQ-32B?expand[]=inferenceProviderMapping
+
+Document raw HTTP requests + JS/Python equivalent in SDKs

docs/api-inference/hub-api.md

@@ -0,0 +1,17 @@
+# Hub Integration
+
+**TODO:**
+- search for models (UI): https://huggingface.co/models?inference_provider=fireworks-ai&sort=trending
+- search all models (UI): https://huggingface.co/models?inference_provider=all&sort=trending
+- set custom API key from provider (optional)
+- order providers by preference (apply to widget and code snippets)
+
+### Features using Inference Providers
+
+Several Hugging Face features utilize the Inference Providers API and count towards your monthly credits:
+
+- Inference Widgets: Interactive widgets available on model pages.
+- [Inference Playground](https://huggingface.co/playground): A comprehensive chat interface supporting various models and providers.
+- Data Studio AI: Converts text to SQL queries for datasets.
+
+The included monthly credits for PRO and Enterprise should cover moderate usage of these features for most users.