Complete a canonical run
curl --request POST \
--url https://api.veryfront.com/runs/{run_id}/complete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {
"provider": "<string>",
"model": "<string>",
"inputTokens": 123,
"outputTokens": 123,
"finishReason": "<string>",
"totalTokens": 123,
"cachedInputTokens": 123,
"cacheCreationInputTokens": 123,
"cacheReadInputTokens": 123,
"reasoningTokens": 123,
"durationMs": 1,
"latencyMs": 1,
"timeToFirstTokenMs": 1,
"costUsd": "<string>",
"providerInputCostUsd": "<string>",
"providerOutputCostUsd": "<string>",
"providerCostUsd": "<string>",
"veryfrontInputChargeUsd": "<string>",
"veryfrontOutputChargeUsd": "<string>",
"veryfrontChargeUsd": "<string>",
"veryfrontBilledUsd": "<string>",
"costCredits": "<string>",
"billableInputTokens": 1,
"billableOutputTokens": 1,
"providerRequestId": "<string>"
},
"terminal_error_code": "<string>",
"terminal_error_message": "<string>"
}
'import requests
url = "https://api.veryfront.com/runs/{run_id}/complete"
payload = {
"metadata": {
"provider": "<string>",
"model": "<string>",
"inputTokens": 123,
"outputTokens": 123,
"finishReason": "<string>",
"totalTokens": 123,
"cachedInputTokens": 123,
"cacheCreationInputTokens": 123,
"cacheReadInputTokens": 123,
"reasoningTokens": 123,
"durationMs": 1,
"latencyMs": 1,
"timeToFirstTokenMs": 1,
"costUsd": "<string>",
"providerInputCostUsd": "<string>",
"providerOutputCostUsd": "<string>",
"providerCostUsd": "<string>",
"veryfrontInputChargeUsd": "<string>",
"veryfrontOutputChargeUsd": "<string>",
"veryfrontChargeUsd": "<string>",
"veryfrontBilledUsd": "<string>",
"costCredits": "<string>",
"billableInputTokens": 1,
"billableOutputTokens": 1,
"providerRequestId": "<string>"
},
"terminal_error_code": "<string>",
"terminal_error_message": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {
provider: '<string>',
model: '<string>',
inputTokens: 123,
outputTokens: 123,
finishReason: '<string>',
totalTokens: 123,
cachedInputTokens: 123,
cacheCreationInputTokens: 123,
cacheReadInputTokens: 123,
reasoningTokens: 123,
durationMs: 1,
latencyMs: 1,
timeToFirstTokenMs: 1,
costUsd: '<string>',
providerInputCostUsd: '<string>',
providerOutputCostUsd: '<string>',
providerCostUsd: '<string>',
veryfrontInputChargeUsd: '<string>',
veryfrontOutputChargeUsd: '<string>',
veryfrontChargeUsd: '<string>',
veryfrontBilledUsd: '<string>',
costCredits: '<string>',
billableInputTokens: 1,
billableOutputTokens: 1,
providerRequestId: '<string>'
},
terminal_error_code: '<string>',
terminal_error_message: '<string>'
})
};
fetch('https://api.veryfront.com/runs/{run_id}/complete', 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.veryfront.com/runs/{run_id}/complete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'metadata' => [
'provider' => '<string>',
'model' => '<string>',
'inputTokens' => 123,
'outputTokens' => 123,
'finishReason' => '<string>',
'totalTokens' => 123,
'cachedInputTokens' => 123,
'cacheCreationInputTokens' => 123,
'cacheReadInputTokens' => 123,
'reasoningTokens' => 123,
'durationMs' => 1,
'latencyMs' => 1,
'timeToFirstTokenMs' => 1,
'costUsd' => '<string>',
'providerInputCostUsd' => '<string>',
'providerOutputCostUsd' => '<string>',
'providerCostUsd' => '<string>',
'veryfrontInputChargeUsd' => '<string>',
'veryfrontOutputChargeUsd' => '<string>',
'veryfrontChargeUsd' => '<string>',
'veryfrontBilledUsd' => '<string>',
'costCredits' => '<string>',
'billableInputTokens' => 1,
'billableOutputTokens' => 1,
'providerRequestId' => '<string>'
],
'terminal_error_code' => '<string>',
'terminal_error_message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.veryfront.com/runs/{run_id}/complete"
payload := strings.NewReader("{\n \"metadata\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\",\n \"inputTokens\": 123,\n \"outputTokens\": 123,\n \"finishReason\": \"<string>\",\n \"totalTokens\": 123,\n \"cachedInputTokens\": 123,\n \"cacheCreationInputTokens\": 123,\n \"cacheReadInputTokens\": 123,\n \"reasoningTokens\": 123,\n \"durationMs\": 1,\n \"latencyMs\": 1,\n \"timeToFirstTokenMs\": 1,\n \"costUsd\": \"<string>\",\n \"providerInputCostUsd\": \"<string>\",\n \"providerOutputCostUsd\": \"<string>\",\n \"providerCostUsd\": \"<string>\",\n \"veryfrontInputChargeUsd\": \"<string>\",\n \"veryfrontOutputChargeUsd\": \"<string>\",\n \"veryfrontChargeUsd\": \"<string>\",\n \"veryfrontBilledUsd\": \"<string>\",\n \"costCredits\": \"<string>\",\n \"billableInputTokens\": 1,\n \"billableOutputTokens\": 1,\n \"providerRequestId\": \"<string>\"\n },\n \"terminal_error_code\": \"<string>\",\n \"terminal_error_message\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.veryfront.com/runs/{run_id}/complete")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\",\n \"inputTokens\": 123,\n \"outputTokens\": 123,\n \"finishReason\": \"<string>\",\n \"totalTokens\": 123,\n \"cachedInputTokens\": 123,\n \"cacheCreationInputTokens\": 123,\n \"cacheReadInputTokens\": 123,\n \"reasoningTokens\": 123,\n \"durationMs\": 1,\n \"latencyMs\": 1,\n \"timeToFirstTokenMs\": 1,\n \"costUsd\": \"<string>\",\n \"providerInputCostUsd\": \"<string>\",\n \"providerOutputCostUsd\": \"<string>\",\n \"providerCostUsd\": \"<string>\",\n \"veryfrontInputChargeUsd\": \"<string>\",\n \"veryfrontOutputChargeUsd\": \"<string>\",\n \"veryfrontChargeUsd\": \"<string>\",\n \"veryfrontBilledUsd\": \"<string>\",\n \"costCredits\": \"<string>\",\n \"billableInputTokens\": 1,\n \"billableOutputTokens\": 1,\n \"providerRequestId\": \"<string>\"\n },\n \"terminal_error_code\": \"<string>\",\n \"terminal_error_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.veryfront.com/runs/{run_id}/complete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\",\n \"inputTokens\": 123,\n \"outputTokens\": 123,\n \"finishReason\": \"<string>\",\n \"totalTokens\": 123,\n \"cachedInputTokens\": 123,\n \"cacheCreationInputTokens\": 123,\n \"cacheReadInputTokens\": 123,\n \"reasoningTokens\": 123,\n \"durationMs\": 1,\n \"latencyMs\": 1,\n \"timeToFirstTokenMs\": 1,\n \"costUsd\": \"<string>\",\n \"providerInputCostUsd\": \"<string>\",\n \"providerOutputCostUsd\": \"<string>\",\n \"providerCostUsd\": \"<string>\",\n \"veryfrontInputChargeUsd\": \"<string>\",\n \"veryfrontOutputChargeUsd\": \"<string>\",\n \"veryfrontChargeUsd\": \"<string>\",\n \"veryfrontBilledUsd\": \"<string>\",\n \"costCredits\": \"<string>\",\n \"billableInputTokens\": 1,\n \"billableOutputTokens\": 1,\n \"providerRequestId\": \"<string>\"\n },\n \"terminal_error_code\": \"<string>\",\n \"terminal_error_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"completed": true,
"run": {
"run_id": "<string>",
"owner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"usage": {
"requests": 1,
"input_tokens": 1,
"output_tokens": 1,
"cache_creation_input_tokens": 1,
"cache_read_input_tokens": 1,
"reasoning_tokens": 1,
"cost_credits": "<string>"
},
"parent_run_id": "<string>",
"root_run_id": "<string>",
"target": "<string>",
"workflow_id": "<string>",
"schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"error": {
"message": "<string>",
"code": "<string>"
},
"logs": "<string>",
"artifacts": [
null
],
"duration_ms": 123,
"exit_code": 123,
"start_mode": "<string>",
"timeout_seconds": 123,
"backoff_limit": 123,
"trigger_id": "<string>",
"created_by": "<string>",
"updated_at": "<string>",
"created_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"metadata": null,
"input": null,
"config": null,
"output": null
}
}Marks a canonical durable run complete with the provided completion payload.
POST
/
runs
/
{run_id}
/
complete
Complete a canonical run
curl --request POST \
--url https://api.veryfront.com/runs/{run_id}/complete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {
"provider": "<string>",
"model": "<string>",
"inputTokens": 123,
"outputTokens": 123,
"finishReason": "<string>",
"totalTokens": 123,
"cachedInputTokens": 123,
"cacheCreationInputTokens": 123,
"cacheReadInputTokens": 123,
"reasoningTokens": 123,
"durationMs": 1,
"latencyMs": 1,
"timeToFirstTokenMs": 1,
"costUsd": "<string>",
"providerInputCostUsd": "<string>",
"providerOutputCostUsd": "<string>",
"providerCostUsd": "<string>",
"veryfrontInputChargeUsd": "<string>",
"veryfrontOutputChargeUsd": "<string>",
"veryfrontChargeUsd": "<string>",
"veryfrontBilledUsd": "<string>",
"costCredits": "<string>",
"billableInputTokens": 1,
"billableOutputTokens": 1,
"providerRequestId": "<string>"
},
"terminal_error_code": "<string>",
"terminal_error_message": "<string>"
}
'import requests
url = "https://api.veryfront.com/runs/{run_id}/complete"
payload = {
"metadata": {
"provider": "<string>",
"model": "<string>",
"inputTokens": 123,
"outputTokens": 123,
"finishReason": "<string>",
"totalTokens": 123,
"cachedInputTokens": 123,
"cacheCreationInputTokens": 123,
"cacheReadInputTokens": 123,
"reasoningTokens": 123,
"durationMs": 1,
"latencyMs": 1,
"timeToFirstTokenMs": 1,
"costUsd": "<string>",
"providerInputCostUsd": "<string>",
"providerOutputCostUsd": "<string>",
"providerCostUsd": "<string>",
"veryfrontInputChargeUsd": "<string>",
"veryfrontOutputChargeUsd": "<string>",
"veryfrontChargeUsd": "<string>",
"veryfrontBilledUsd": "<string>",
"costCredits": "<string>",
"billableInputTokens": 1,
"billableOutputTokens": 1,
"providerRequestId": "<string>"
},
"terminal_error_code": "<string>",
"terminal_error_message": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {
provider: '<string>',
model: '<string>',
inputTokens: 123,
outputTokens: 123,
finishReason: '<string>',
totalTokens: 123,
cachedInputTokens: 123,
cacheCreationInputTokens: 123,
cacheReadInputTokens: 123,
reasoningTokens: 123,
durationMs: 1,
latencyMs: 1,
timeToFirstTokenMs: 1,
costUsd: '<string>',
providerInputCostUsd: '<string>',
providerOutputCostUsd: '<string>',
providerCostUsd: '<string>',
veryfrontInputChargeUsd: '<string>',
veryfrontOutputChargeUsd: '<string>',
veryfrontChargeUsd: '<string>',
veryfrontBilledUsd: '<string>',
costCredits: '<string>',
billableInputTokens: 1,
billableOutputTokens: 1,
providerRequestId: '<string>'
},
terminal_error_code: '<string>',
terminal_error_message: '<string>'
})
};
fetch('https://api.veryfront.com/runs/{run_id}/complete', 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.veryfront.com/runs/{run_id}/complete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'metadata' => [
'provider' => '<string>',
'model' => '<string>',
'inputTokens' => 123,
'outputTokens' => 123,
'finishReason' => '<string>',
'totalTokens' => 123,
'cachedInputTokens' => 123,
'cacheCreationInputTokens' => 123,
'cacheReadInputTokens' => 123,
'reasoningTokens' => 123,
'durationMs' => 1,
'latencyMs' => 1,
'timeToFirstTokenMs' => 1,
'costUsd' => '<string>',
'providerInputCostUsd' => '<string>',
'providerOutputCostUsd' => '<string>',
'providerCostUsd' => '<string>',
'veryfrontInputChargeUsd' => '<string>',
'veryfrontOutputChargeUsd' => '<string>',
'veryfrontChargeUsd' => '<string>',
'veryfrontBilledUsd' => '<string>',
'costCredits' => '<string>',
'billableInputTokens' => 1,
'billableOutputTokens' => 1,
'providerRequestId' => '<string>'
],
'terminal_error_code' => '<string>',
'terminal_error_message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.veryfront.com/runs/{run_id}/complete"
payload := strings.NewReader("{\n \"metadata\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\",\n \"inputTokens\": 123,\n \"outputTokens\": 123,\n \"finishReason\": \"<string>\",\n \"totalTokens\": 123,\n \"cachedInputTokens\": 123,\n \"cacheCreationInputTokens\": 123,\n \"cacheReadInputTokens\": 123,\n \"reasoningTokens\": 123,\n \"durationMs\": 1,\n \"latencyMs\": 1,\n \"timeToFirstTokenMs\": 1,\n \"costUsd\": \"<string>\",\n \"providerInputCostUsd\": \"<string>\",\n \"providerOutputCostUsd\": \"<string>\",\n \"providerCostUsd\": \"<string>\",\n \"veryfrontInputChargeUsd\": \"<string>\",\n \"veryfrontOutputChargeUsd\": \"<string>\",\n \"veryfrontChargeUsd\": \"<string>\",\n \"veryfrontBilledUsd\": \"<string>\",\n \"costCredits\": \"<string>\",\n \"billableInputTokens\": 1,\n \"billableOutputTokens\": 1,\n \"providerRequestId\": \"<string>\"\n },\n \"terminal_error_code\": \"<string>\",\n \"terminal_error_message\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.veryfront.com/runs/{run_id}/complete")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\",\n \"inputTokens\": 123,\n \"outputTokens\": 123,\n \"finishReason\": \"<string>\",\n \"totalTokens\": 123,\n \"cachedInputTokens\": 123,\n \"cacheCreationInputTokens\": 123,\n \"cacheReadInputTokens\": 123,\n \"reasoningTokens\": 123,\n \"durationMs\": 1,\n \"latencyMs\": 1,\n \"timeToFirstTokenMs\": 1,\n \"costUsd\": \"<string>\",\n \"providerInputCostUsd\": \"<string>\",\n \"providerOutputCostUsd\": \"<string>\",\n \"providerCostUsd\": \"<string>\",\n \"veryfrontInputChargeUsd\": \"<string>\",\n \"veryfrontOutputChargeUsd\": \"<string>\",\n \"veryfrontChargeUsd\": \"<string>\",\n \"veryfrontBilledUsd\": \"<string>\",\n \"costCredits\": \"<string>\",\n \"billableInputTokens\": 1,\n \"billableOutputTokens\": 1,\n \"providerRequestId\": \"<string>\"\n },\n \"terminal_error_code\": \"<string>\",\n \"terminal_error_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.veryfront.com/runs/{run_id}/complete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {\n \"provider\": \"<string>\",\n \"model\": \"<string>\",\n \"inputTokens\": 123,\n \"outputTokens\": 123,\n \"finishReason\": \"<string>\",\n \"totalTokens\": 123,\n \"cachedInputTokens\": 123,\n \"cacheCreationInputTokens\": 123,\n \"cacheReadInputTokens\": 123,\n \"reasoningTokens\": 123,\n \"durationMs\": 1,\n \"latencyMs\": 1,\n \"timeToFirstTokenMs\": 1,\n \"costUsd\": \"<string>\",\n \"providerInputCostUsd\": \"<string>\",\n \"providerOutputCostUsd\": \"<string>\",\n \"providerCostUsd\": \"<string>\",\n \"veryfrontInputChargeUsd\": \"<string>\",\n \"veryfrontOutputChargeUsd\": \"<string>\",\n \"veryfrontChargeUsd\": \"<string>\",\n \"veryfrontBilledUsd\": \"<string>\",\n \"costCredits\": \"<string>\",\n \"billableInputTokens\": 1,\n \"billableOutputTokens\": 1,\n \"providerRequestId\": \"<string>\"\n },\n \"terminal_error_code\": \"<string>\",\n \"terminal_error_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"completed": true,
"run": {
"run_id": "<string>",
"owner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"usage": {
"requests": 1,
"input_tokens": 1,
"output_tokens": 1,
"cache_creation_input_tokens": 1,
"cache_read_input_tokens": 1,
"reasoning_tokens": 1,
"cost_credits": "<string>"
},
"parent_run_id": "<string>",
"root_run_id": "<string>",
"target": "<string>",
"workflow_id": "<string>",
"schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"error": {
"message": "<string>",
"code": "<string>"
},
"logs": "<string>",
"artifacts": [
null
],
"duration_ms": 123,
"exit_code": 123,
"start_mode": "<string>",
"timeout_seconds": 123,
"backoff_limit": 123,
"trigger_id": "<string>",
"created_by": "<string>",
"updated_at": "<string>",
"created_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"metadata": null,
"input": null,
"config": null,
"output": null
}
}Authorizations
bearerAuthapiKeyAuth
Use a JWT bearer token or a Veryfront API key in the Authorization header.
Path Parameters
Minimum string length:
1Body
application/json
⌘I