From ec63e8eb9fa9886b2ad824e1e52295666fe2698c Mon Sep 17 00:00:00 2001 From: karishmas6 Date: Tue, 29 Oct 2024 00:14:26 +0530 Subject: [PATCH] chore: better explanation --- server/src/api/record.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server/src/api/record.ts b/server/src/api/record.ts index 46b4fe31..8608d457 100644 --- a/server/src/api/record.ts +++ b/server/src/api/record.ts @@ -664,7 +664,7 @@ async function waitForRunCompletion(runId: string, interval: number = 2000) { * /api/robots/{id}/runs: * post: * summary: Run a robot by ID - * description: When you need to run a robot and get its captured data, you can use this endpoint to run the task. For now, you can poll the GET endpoint to retrieve a task's details as soon as it is finished. We are working on adding a webhook feature to notify you when a task is finished. + * description: When you need to run a robot and get its captured data, you can use this endpoint to create a run for the robot. For now, you can poll the GET endpoint to retrieve a run's details as soon as it is finished. We are working on adding a webhook feature to notify you when a run is finished. * security: * - api_key: [] * parameters: