Skip to main content
GET
/
api
/
repos
/
{namespace}
/
{repo_name}
/
evaluations
/
{evaluation_id}
Get evaluation status
curl --request GET \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/evaluations/{evaluation_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/evaluations/{evaluation_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/evaluations/{evaluation_id}', 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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/evaluations/{evaluation_id}",
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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/evaluations/{evaluation_id}"

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://hub.oxen.ai/api/repos/{namespace}/{repo_name}/evaluations/{evaluation_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/evaluations/{evaluation_id}")

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
{
  "evaluation": {
    "cancelled_at": "<string>",
    "completed_at": "<string>",
    "completion_tokens_used": 123,
    "created_by": {
      "id": "<string>",
      "image": "<string>",
      "name": "<string>",
      "username": "<string>"
    },
    "credits_used": 123,
    "error_message": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "inserted_at": "<string>",
    "is_sample": true,
    "model": {},
    "name": "<string>",
    "progress": {
      "processed": 123,
      "total": 123
    },
    "prompt": "<string>",
    "prompt_tokens_used": 123,
    "repository_id": "<string>",
    "resource": {
      "path": "<string>",
      "version": "<string>"
    },
    "sample_count": 123,
    "started_at": "<string>",
    "target_branch": "<string>",
    "target_column": "<string>",
    "target_path": "<string>",
    "tokens_used": 123
  },
  "status": "<string>",
  "status_message": "<string>"
}
{}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

evaluation_id
string
required

Evaluation ID

Response

Evaluation details

Standard response wrapper for a single evaluation.

evaluation
Evaluation · object

Evaluation resource

status
string

High-level status string (for example, 'success').

status_message
string

Human-readable status message (for example, 'resource_found').