Runs
Get a run's current status, including its tool invocations
GET
/
api
/
v1
/
runs
/
{runId}
Get a run's current status, including its tool invocations
curl --request GET \
--url https://api.vyomflow.co.in/api/v1/runs/{runId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vyomflow.co.in/api/v1/runs/{runId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vyomflow.co.in/api/v1/runs/{runId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vyomflow.co.in/api/v1/runs/{runId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vyomflow.co.in/api/v1/runs/{runId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vyomflow.co.in/api/v1/runs/{runId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vyomflow.co.in/api/v1/runs/{runId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"chatId": "<string>",
"status": "queued",
"userMessageId": "<string>",
"assistantMessageId": "<string>",
"lastStreamIndex": 123,
"cancelRequestedAt": "<string>",
"requestedModel": "<string>",
"resolvedModel": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"startedAt": "<string>",
"finishedAt": "<string>",
"toolInvocations": [
{
"id": "<string>",
"agentRunId": "<string>",
"turnIndex": 1,
"callIndex": 1,
"toolCallId": "<string>",
"name": "<string>",
"nodeType": "<string>",
"input": {},
"status": "DISPATCHING",
"creditEstimate": 1,
"creditUsed": 1,
"resultUrls": [
"<string>"
],
"errorCode": "<string>",
"errorMessage": "<string>",
"startedAt": "<string>",
"finishedAt": "<string>",
"durationMs": 1,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"totalCreditsUsed": 1,
"pendingWaitpoint": {
"id": "<string>",
"agentRunId": "<string>",
"kind": "CREDIT_APPROVAL",
"status": "PENDING",
"requestPayload": {
"toolName": "<string>",
"estimatedCredits": 1,
"threshold": 1
},
"resolvedPayload": {
"approved": true,
"respondedAt": "<string>"
},
"expiresAt": "<string>",
"resolvedAt": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}Authorizations
Clerk session token, Authorization: Bearer <token> — the first-party browser app's own auth. Used only by this internal /api/v1/* surface, never by /api/public/v1/*.
Path Parameters
Minimum string length:
1Response
The run.
Available options:
queued, running, waiting, completed, failed, cancelled Show child attributes
Show child attributes
Required range:
x >= 0- Option 1
- Option 2
Show child attributes
Show child attributes
⌘I
Get a run's current status, including its tool invocations
curl --request GET \
--url https://api.vyomflow.co.in/api/v1/runs/{runId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vyomflow.co.in/api/v1/runs/{runId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vyomflow.co.in/api/v1/runs/{runId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vyomflow.co.in/api/v1/runs/{runId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vyomflow.co.in/api/v1/runs/{runId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vyomflow.co.in/api/v1/runs/{runId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vyomflow.co.in/api/v1/runs/{runId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"chatId": "<string>",
"status": "queued",
"userMessageId": "<string>",
"assistantMessageId": "<string>",
"lastStreamIndex": 123,
"cancelRequestedAt": "<string>",
"requestedModel": "<string>",
"resolvedModel": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"startedAt": "<string>",
"finishedAt": "<string>",
"toolInvocations": [
{
"id": "<string>",
"agentRunId": "<string>",
"turnIndex": 1,
"callIndex": 1,
"toolCallId": "<string>",
"name": "<string>",
"nodeType": "<string>",
"input": {},
"status": "DISPATCHING",
"creditEstimate": 1,
"creditUsed": 1,
"resultUrls": [
"<string>"
],
"errorCode": "<string>",
"errorMessage": "<string>",
"startedAt": "<string>",
"finishedAt": "<string>",
"durationMs": 1,
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"totalCreditsUsed": 1,
"pendingWaitpoint": {
"id": "<string>",
"agentRunId": "<string>",
"kind": "CREDIT_APPROVAL",
"status": "PENDING",
"requestPayload": {
"toolName": "<string>",
"estimatedCredits": 1,
"threshold": 1
},
"resolvedPayload": {
"approved": true,
"respondedAt": "<string>"
},
"expiresAt": "<string>",
"resolvedAt": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}