Leon4gr45 commited on
Commit
2aef9af
·
verified ·
1 Parent(s): 33962ff

Upload Agent.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. Agent.md +179 -35
Agent.md CHANGED
@@ -48,29 +48,185 @@ Every deployment **must** expose:
48
  `https://HF_PROFILE-openweb.hf.space/api-docs`
49
 
50
  ### Functional Endpoints
51
- Document each endpoint here. For every endpoint, include:
52
-
53
- - **Method:** GET/POST/PUT/DELETE
54
- - **Path:** `/predict`, `/generate`, `/upload`, etc.
55
- - **Purpose:** What the endpoint does
56
- - **Request Example:** JSON or query parameters
57
- - **Response Example:** JSON schema or example payload
58
-
59
- Example format:
60
-
61
- ```
62
- ### /predict
63
- - Method: POST
64
- - Purpose: Run model inference
65
- - Request:
66
- {
67
- "text": "hello world"
68
- }
69
- - Response:
70
- {
71
- "prediction": "…"
72
- }
73
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
74
 
75
  All endpoints listed here **must** appear in `/api-docs`.
76
 
@@ -85,15 +241,3 @@ After any code change, run:
85
 
86
  ```bash
87
  hf upload Leon4gr45/openweb --repo-type=space
88
- ---
89
-
90
- Scan build and run logs # Get build logs (SSE) curl -N
91
- -H "Authorization: Bearer HF_TOKEN"
92
- "https://huggingface.co/api/spaces/Leon4gr45/openweb/logs/build"
93
-
94
- Get run logs (SSE) once the build logs succeed
95
- curl -N
96
- -H "Authorization: Bearer HF_TOKEN"
97
- "https://huggingface.co/api/spaces/Leon4gr45/openweb/logs/run"
98
-
99
- after 300 seconds to see if the deployment has been successful, and if not, fix the errors of deployment, and redeploy and monitor in a cycle until the space is running and reacts to the api endpoints you created.
 
48
  `https://HF_PROFILE-openweb.hf.space/api-docs`
49
 
50
  ### Functional Endpoints
51
+ ### /api/stats
52
+ - Method: GET
53
+ - Purpose: Stats
54
+
55
+ ### /api/videos
56
+ - Method: GET
57
+ - Purpose: Videos
58
+
59
+ ### /api/videos/{video_id}
60
+ - Method: GET
61
+ - Purpose: Video
62
+
63
+ ### /api/search
64
+ - Method: GET
65
+ - Purpose: Search
66
+
67
+ ### /api/search/image
68
+ - Method: POST
69
+ - Purpose: Search Image
70
+
71
+ ### /api/compare
72
+ - Method: GET
73
+ - Purpose: Compare
74
+
75
+ ### /api/compare-views
76
+ - Method: GET
77
+ - Purpose: Compare Views
78
+
79
+ ### /api/ask
80
+ - Method: POST
81
+ - Purpose: Ask
82
+
83
+ ### /api/answers
84
+ - Method: GET
85
+ - Purpose: Answers
86
+
87
+ ### /api/experiments
88
+ - Method: GET
89
+ - Purpose: Experiments
90
+
91
+ ### /api/health
92
+ - Method: GET
93
+ - Purpose: Health
94
+
95
+ ### /api/providers
96
+ - Method: GET
97
+ - Purpose: Providers
98
+
99
+ ### /api/config
100
+ - Method: GET
101
+ - Purpose: Get Config
102
+
103
+ ### /api/config/template
104
+ - Method: GET
105
+ - Purpose: Template
106
+
107
+ ### /api/config/profiles
108
+ - Method: GET
109
+ - Purpose: Profiles
110
+
111
+ ### /api/config/validate
112
+ - Method: POST
113
+ - Purpose: Validate Config
114
+
115
+ ### /api/config/apply
116
+ - Method: POST
117
+ - Purpose: Apply Config
118
+
119
+ ### /api/config/rollback
120
+ - Method: POST
121
+ - Purpose: Rollback
122
+
123
+ ### /api/providers/{pid}/test
124
+ - Method: POST
125
+ - Purpose: Test Provider
126
+
127
+ ### /api/routing/dry-run
128
+ - Method: POST
129
+ - Purpose: Dry Run
130
+
131
+ ### /api/live/sessions
132
+ - Method: POST
133
+ - Purpose: Create Session
134
+
135
+ ### /api/live/sessions/{sid}
136
+ - Method: DELETE
137
+ - Purpose: Delete Session
138
+
139
+ ### /api/live/sessions/{sid}/frames
140
+ - Method: POST
141
+ - Purpose: Analyze Frame
142
+
143
+ ### /api/live/sessions/{sid}/events
144
+ - Method: GET
145
+ - Purpose: Events
146
+
147
+ ### /api/live/sessions/{sid}/transcribe
148
+ - Method: POST
149
+ - Purpose: Transcribe
150
+
151
+ ### /api/live/sessions/{sid}/guidance
152
+ - Method: POST
153
+ - Purpose: Guidance
154
+
155
+ ### /api/live/sessions/{sid}/task
156
+ - Method: PUT
157
+ - Purpose: Task State
158
+
159
+ ### /api/access
160
+ - Method: POST
161
+ - Purpose: Media Access
162
+
163
+ ### /api/access
164
+ - Method: DELETE
165
+ - Purpose: Clear Media Access
166
+
167
+ ### /api/admin/backup-status
168
+ - Method: GET
169
+ - Purpose: Backup Status
170
+
171
+ ### /api/admin/backup
172
+ - Method: POST
173
+ - Purpose: Backup Trigger
174
+
175
+ ### /api/admin/backup/recovery-test
176
+ - Method: POST
177
+ - Purpose: Backup Recovery Test
178
+
179
+ ### /api/live/sessions/{sid}/routing
180
+ - Method: PUT
181
+ - Purpose: Session Routing
182
+
183
+ ### /api/demo/videos
184
+ - Method: GET
185
+ - Purpose: Library
186
+
187
+ ### /api/demo/videos/{vid}
188
+ - Method: GET
189
+ - Purpose: Detail
190
+
191
+ ### /api/demo/stats
192
+ - Method: GET
193
+ - Purpose: Stats
194
+
195
+ ### /api/demo/search
196
+ - Method: GET
197
+ - Purpose: Search
198
+
199
+ ### /api/demo/ask
200
+ - Method: POST
201
+ - Purpose: Ask
202
+
203
+ ### /api/demo/answers
204
+ - Method: GET
205
+ - Purpose: History
206
+
207
+ ### /api/demo/compare
208
+ - Method: GET
209
+ - Purpose: Compare
210
+
211
+ ### /api/demo/compare-views
212
+ - Method: GET
213
+ - Purpose: Compare Views
214
+
215
+ ### /api/demo/experiments
216
+ - Method: GET
217
+ - Purpose: Experiments
218
+
219
+ ### /api/jobs
220
+ - Method: GET
221
+ - Purpose: Jobs
222
+
223
+ ### /api/ingest
224
+ - Method: POST
225
+ - Purpose: Upload
226
+
227
+ ### /api/jobs/{jid}
228
+ - Method: POST
229
+ - Purpose: Action
230
 
231
  All endpoints listed here **must** appear in `/api-docs`.
232
 
 
241
 
242
  ```bash
243
  hf upload Leon4gr45/openweb --repo-type=space