|
165 | 165 | } |
166 | 166 | } |
167 | 167 | }, |
168 | | - "/v1/organizations/{org_id}/agent/run": { |
169 | | - "post": { |
170 | | - "tags": ["agents", "agents", "agents"], |
171 | | - "summary": "Create Agent Run", |
172 | | - "description": "Create a new agent run.\n\nCreates and initiates a long-running agent process based on the provided prompt.\nThe process will complete asynchronously, and the response contains the agent run ID\nwhich can be used to check the status later. The requesting user must be a member\nof the specified organization.\n\nRate limit: 10 requests per minute.", |
173 | | - "operationId": "create_agent_run_v1_organizations__org_id__agent_run_post", |
174 | | - "parameters": [ |
175 | | - { |
176 | | - "name": "org_id", |
177 | | - "in": "path", |
178 | | - "required": true, |
179 | | - "schema": { "type": "integer", "title": "Org Id" } |
180 | | - }, |
181 | | - { |
182 | | - "name": "authorization", |
183 | | - "in": "header", |
184 | | - "required": false, |
185 | | - "schema": { "title": "Authorization" } |
186 | | - } |
187 | | - ], |
188 | | - "requestBody": { |
189 | | - "required": true, |
190 | | - "content": { |
191 | | - "application/json": { |
192 | | - "schema": { "$ref": "#/components/schemas/CreateAgentRunInput" } |
193 | | - } |
194 | | - } |
195 | | - }, |
196 | | - "responses": { |
197 | | - "200": { |
198 | | - "description": "Successful Response", |
199 | | - "content": { |
200 | | - "application/json": { |
201 | | - "schema": { "$ref": "#/components/schemas/AgentRunResponse" } |
202 | | - } |
203 | | - } |
204 | | - }, |
205 | | - "429": { |
206 | | - "content": { |
207 | | - "application/json": { |
208 | | - "schema": { |
209 | | - "$ref": "#/components/schemas/APIRateLimitErrorResponse" |
210 | | - } |
211 | | - } |
212 | | - }, |
213 | | - "description": "Too Many Requests" |
214 | | - }, |
215 | | - "402": { |
216 | | - "content": { |
217 | | - "application/json": { |
218 | | - "schema": { |
219 | | - "$ref": "#/components/schemas/AgentRunLimitReachedErrorResponse" |
220 | | - } |
221 | | - } |
222 | | - }, |
223 | | - "description": "Payment Required" |
224 | | - }, |
225 | | - "403": { |
226 | | - "content": { |
227 | | - "application/json": { |
228 | | - "schema": { |
229 | | - "$ref": "#/components/schemas/PermissionsErrorResponse" |
230 | | - } |
231 | | - } |
232 | | - }, |
233 | | - "description": "Forbidden" |
234 | | - }, |
235 | | - "422": { |
236 | | - "description": "Validation Error", |
237 | | - "content": { |
238 | | - "application/json": { |
239 | | - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } |
240 | | - } |
241 | | - } |
242 | | - } |
243 | | - } |
244 | | - } |
245 | | - }, |
246 | | - "/v1/organizations/{org_id}/agent/run/{agent_run_id}": { |
247 | | - "get": { |
248 | | - "tags": ["agents", "agents", "agents"], |
249 | | - "summary": "Get Agent Run", |
250 | | - "description": "Retrieve the status and result of an agent run.\n\nReturns the current status, progress, and any available results for the specified agent run.\nThe agent run must belong to the specified organization. If the agent run is still in progress,\nthis endpoint can be polled to check for completion.\n\nRate limit: 60 requests per 30 seconds.", |
251 | | - "operationId": "get_agent_run_v1_organizations__org_id__agent_run__agent_run_id__get", |
252 | | - "parameters": [ |
253 | | - { |
254 | | - "name": "agent_run_id", |
255 | | - "in": "path", |
256 | | - "required": true, |
257 | | - "schema": { "type": "integer", "title": "Agent Run Id" } |
258 | | - }, |
259 | | - { |
260 | | - "name": "org_id", |
261 | | - "in": "path", |
262 | | - "required": true, |
263 | | - "schema": { "type": "integer", "title": "Org Id" } |
264 | | - }, |
265 | | - { |
266 | | - "name": "authorization", |
267 | | - "in": "header", |
268 | | - "required": false, |
269 | | - "schema": { "title": "Authorization" } |
270 | | - } |
271 | | - ], |
272 | | - "responses": { |
273 | | - "200": { |
274 | | - "description": "Successful Response", |
275 | | - "content": { |
276 | | - "application/json": { |
277 | | - "schema": { "$ref": "#/components/schemas/AgentRunResponse" } |
278 | | - } |
279 | | - } |
280 | | - }, |
281 | | - "429": { |
282 | | - "content": { |
283 | | - "application/json": { |
284 | | - "schema": { |
285 | | - "$ref": "#/components/schemas/APIRateLimitErrorResponse" |
286 | | - } |
287 | | - } |
288 | | - }, |
289 | | - "description": "Too Many Requests" |
290 | | - }, |
291 | | - "403": { |
292 | | - "content": { |
293 | | - "application/json": { |
294 | | - "schema": { |
295 | | - "$ref": "#/components/schemas/PermissionsErrorResponse" |
296 | | - } |
297 | | - } |
298 | | - }, |
299 | | - "description": "Forbidden" |
300 | | - }, |
301 | | - "404": { |
302 | | - "content": { |
303 | | - "application/json": { |
304 | | - "schema": { |
305 | | - "$ref": "#/components/schemas/AgentRunNotFoundErrorResponse" |
306 | | - } |
307 | | - } |
308 | | - }, |
309 | | - "description": "Not Found" |
310 | | - }, |
311 | | - "422": { |
312 | | - "description": "Validation Error", |
313 | | - "content": { |
314 | | - "application/json": { |
315 | | - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } |
316 | | - } |
317 | | - } |
318 | | - } |
319 | | - } |
320 | | - } |
321 | | - }, |
322 | 168 | "/v1/organizations": { |
323 | 169 | "get": { |
324 | 170 | "tags": ["organizations", "organizations", "organizations"], |
|
407 | 253 | "type": "object", |
408 | 254 | "title": "APIRateLimitErrorResponse" |
409 | 255 | }, |
410 | | - "AgentRunLimitReachedErrorResponse": { |
411 | | - "properties": { |
412 | | - "message": { |
413 | | - "type": "string", |
414 | | - "title": "Message", |
415 | | - "default": "Alloted agent runs for the current billing plan have been reached. Please upgrade your plan to continue." |
416 | | - }, |
417 | | - "status_code": { |
418 | | - "type": "integer", |
419 | | - "title": "Status Code", |
420 | | - "default": 402 |
421 | | - } |
422 | | - }, |
423 | | - "type": "object", |
424 | | - "title": "AgentRunLimitReachedErrorResponse" |
425 | | - }, |
426 | | - "AgentRunNotFoundErrorResponse": { |
427 | | - "properties": { |
428 | | - "message": { |
429 | | - "type": "string", |
430 | | - "title": "Message", |
431 | | - "default": "Agent run not found." |
432 | | - }, |
433 | | - "status_code": { |
434 | | - "type": "integer", |
435 | | - "title": "Status Code", |
436 | | - "default": 404 |
437 | | - } |
438 | | - }, |
439 | | - "type": "object", |
440 | | - "title": "AgentRunNotFoundErrorResponse" |
441 | | - }, |
442 | | - "AgentRunResponse": { |
443 | | - "properties": { |
444 | | - "id": { "type": "integer", "title": "Id" }, |
445 | | - "organization_id": { "type": "integer", "title": "Organization Id" }, |
446 | | - "status": { |
447 | | - "anyOf": [{ "type": "string" }, { "type": "null" }], |
448 | | - "title": "Status" |
449 | | - }, |
450 | | - "created_at": { |
451 | | - "anyOf": [{ "type": "string" }, { "type": "null" }], |
452 | | - "title": "Created At" |
453 | | - }, |
454 | | - "web_url": { |
455 | | - "anyOf": [{ "type": "string" }, { "type": "null" }], |
456 | | - "title": "Web Url" |
457 | | - }, |
458 | | - "result": { |
459 | | - "anyOf": [{ "type": "string" }, { "type": "null" }], |
460 | | - "title": "Result" |
461 | | - } |
462 | | - }, |
463 | | - "type": "object", |
464 | | - "required": ["id", "organization_id"], |
465 | | - "title": "AgentRunResponse", |
466 | | - "description": "Represents an agent run in API responses" |
467 | | - }, |
468 | | - "CreateAgentRunInput": { |
469 | | - "properties": { "prompt": { "type": "string", "title": "Prompt" } }, |
470 | | - "type": "object", |
471 | | - "required": ["prompt"], |
472 | | - "title": "CreateAgentRunInput" |
473 | | - }, |
474 | 256 | "HTTPValidationError": { |
475 | 257 | "properties": { |
476 | 258 | "detail": { |
|
0 commit comments