Get parse status
Returns the status of all active and queued parse jobs
1 min read
gethttps://your-instance.example.com/api/parse-status
Request example
curl --request GET \
--url https://your-instance.example.com/api/parse-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/parse-status"
headers = {
"Authorization": "Bearer <token>",
}
response = requests.request("GET", url, headers=headers)
print(response.text)const response = await fetch('https://your-instance.example.com/api/parse-status', {
method: 'GET',
headers: {
'Authorization': 'Bearer <token>'
}
});
const data = await response.json();
console.log(data);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://your-instance.example.com/api/parse-status',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://your-instance.example.com/api/parse-status"
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))
}HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://your-instance.example.com/api/parse-status"))
.header("Authorization", "Bearer <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require 'uri'
require 'net/http'
url = URI('https://your-instance.example.com/api/parse-status')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'
request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyResponse
{
"activeParses": {
"/your-org/your-repo": {
"status": "parsing",
"startedAt": "2025-01-01T12:00:00.000Z",
"duration": 8.6,
"statusMessage": "Scanning 16 files"
},
"/other-org/other-repo": {
"status": "queued",
"position": 1,
"createdAt": "2025-01-01T12:00:01.000Z"
}
}
}{
"error": "Authentication required"
}{
"error": "An unexpected error occurred"
}gethttps://your-instance.example.com/api/parse-status
Authorization
API key generated from Personal Settings. See Authentication.
Responses
application/json
Active parse jobs and their status
Map of project name to its current parse job status
Show child attributesHide child attributes
Show child attributesHide child attributes
Queue position. Only present when
status is queuedISO 8601 timestamp when the job was queued. Only present when
status is queuedISO 8601 timestamp when the job began running. Only present when
status is parsing or finalizingElapsed seconds since the job started. Only present when
status is parsing or finalizingHuman-readable progress detail (e.g.
Scanning 16 files). Only present when status is parsingHuman-readable error description
Human-readable error description
Was this page helpful?