curl --request POST \
--url https://api.qovery.com/job/{jobId}/buildAnalysis \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"execution_id": "6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42"
}
'import requests
url = "https://api.qovery.com/job/{jobId}/buildAnalysis"
payload = { "execution_id": "6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42" }
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({execution_id: '6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42'})
};
fetch('https://api.qovery.com/job/{jobId}/buildAnalysis', 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.qovery.com/job/{jobId}/buildAnalysis",
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([
'execution_id' => '6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42'
]),
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.qovery.com/job/{jobId}/buildAnalysis"
payload := strings.NewReader("{\n \"execution_id\": \"6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42\"\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.qovery.com/job/{jobId}/buildAnalysis")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"execution_id\": \"6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/job/{jobId}/buildAnalysis")
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 \"execution_id\": \"6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42\"\n}"
response = http.request(request)
puts response.read_body{
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"execution_id": "6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42",
"status": "PENDING",
"stale": true,
"dockerfile_source": "GIT",
"failure_code": "MODEL_ERROR",
"failure_reason": "<string>",
"result": {
"confidence": "HIGH",
"estimated_time_saved": {
"min_seconds": 50,
"max_seconds": 90
},
"assets_reviewed": [
"DOCKERFILE"
],
"summary": "<string>",
"improvements": [
"Copy package.json and package-lock.json before the rest of the code, so the install stays cached until dependencies change"
],
"dockerfile": "<string>",
"dockerfile_rationale": "<string>",
"agent_prompt": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Analyse the latest build of a job
Starts an AI analysis of the latest build of the service. It runs in the background and reports its progress on the websocket route /build/analysis.
The result gives a confidence, the estimated time saved, what was reviewed, a summary, the improvements to make, a prompt for the customer’s own AI agent, and a reworked Dockerfile when an improvement is a Dockerfile change.
Starting an analysis replaces the previous one. It never changes the build or the image.
curl --request POST \
--url https://api.qovery.com/job/{jobId}/buildAnalysis \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"execution_id": "6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42"
}
'import requests
url = "https://api.qovery.com/job/{jobId}/buildAnalysis"
payload = { "execution_id": "6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42" }
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({execution_id: '6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42'})
};
fetch('https://api.qovery.com/job/{jobId}/buildAnalysis', 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.qovery.com/job/{jobId}/buildAnalysis",
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([
'execution_id' => '6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42'
]),
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.qovery.com/job/{jobId}/buildAnalysis"
payload := strings.NewReader("{\n \"execution_id\": \"6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42\"\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.qovery.com/job/{jobId}/buildAnalysis")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"execution_id\": \"6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/job/{jobId}/buildAnalysis")
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 \"execution_id\": \"6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42\"\n}"
response = http.request(request)
puts response.read_body{
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"execution_id": "6e5c1d3a-6b6f-4c35-9a2f-8f1d2c3b4a5e-42",
"status": "PENDING",
"stale": true,
"dockerfile_source": "GIT",
"failure_code": "MODEL_ERROR",
"failure_reason": "<string>",
"result": {
"confidence": "HIGH",
"estimated_time_saved": {
"min_seconds": 50,
"max_seconds": 90
},
"assets_reviewed": [
"DOCKERFILE"
],
"summary": "<string>",
"improvements": [
"Copy package.json and package-lock.json before the rest of the code, so the install stays cached until dependencies change"
],
"dockerfile": "<string>",
"dockerfile_rationale": "<string>",
"agent_prompt": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '
Body
Response
Build analysis started
Was this page helpful?