Retrieve an evaluation

GET

evaluations

{evaluation_id}

curl --request GET \
  --url https://api.physionlabs.ai/v1/evaluations/{evaluation_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.physionlabs.ai/v1/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://api.physionlabs.ai/v1/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://api.physionlabs.ai/v1/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.physionlabs.ai/v1/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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "evaluation",
  "model": "galileo",
  "model_version": "<string>",
  "output_schema_version": "<string>",
  "created": 1,
  "status": "queued",
  "input": {
    "prompt": "<string>",
    "video": {
      "duration_sec": 1,
      "width": 2,
      "height": 2,
      "fps": 123,
      "num_frames": 2
    }
  },
  "usage": {
    "video_seconds": 1,
    "billable_units": 1
  },
  "result": {
    "glitches": [
      {
        "id": "<string>",
        "type": "visual_glitch",
        "description": "<string>",
        "source": "model",
        "region": {
          "start": {
            "frame": 1,
            "sec": 1,
            "timecode": "<string>"
          },
          "end": {
            "frame": 1,
            "sec": 1,
            "timecode": "<string>"
          },
          "boxes": [
            {
              "frame": 1,
              "sec": 1,
              "box": {
                "xmin": 0.5,
                "ymin": 0.5,
                "xmax": 0.5,
                "ymax": 0.5
              }
            }
          ]
        }
      }
    ],
    "summary": {
      "num_glitches": 1,
      "has_visual_glitch": true,
      "has_prompt_misalignment": true
    }
  },
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  },
  "detectors": [
    {
      "detector": "visual_glitch",
      "status": "pending",
      "error": {
        "code": "<string>",
        "message": "<string>"
      }
    }
  ],
  "video_id": "<string>",
  "attempt": 2,
  "timing": {
    "e2e_ms": 1
  },
  "metadata": {}
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

Authorizations

Authorization

string

header

required

Use a key created in the Playground. Keys begin with gk_.

Path Parameters

evaluation_id

string<uuid>

required

Evaluation identifier.

Response

Evaluation found.

string<uuid>

required

object

string

required

Allowed value: "evaluation"

model

enum<string>

default:galileo

required

Available options:

galileo,

gemini

model_version

string

required

output_schema_version

string

required

created

integer

required

Unix timestamp in seconds.

Required range: x >= 0

status

enum<string>

required

Available options:

queued,

processing,

completed,

partial,

failed

input

object

required

Show child attributes

usage

object

required

Show child attributes

result

object | null

required

Show child attributes

error

object | null

Why the run failed, on a failed one. NULL on a run that did not fail, and ABSENT on rows written before this field existed. Not in required, and that is a correction rather than a preference: it was, and the older rows in the store do not carry the key at all. A client that enforced the contract at runtime — the Python one does, since its models validate — raised on any page deep enough to reach them, while the TypeScript client passed because its types are erased before a response is ever seen. So the contract was not merely wrong, it was wrong in a way that only one of the two clients could report. Test for a VALUE, not for the key.

Show child attributes

detectors

object[]

Per-detector state. Older evaluations may omit this field.

Show child attributes

video_id

string | null

Stored video identifier when the evaluation used an uploaded video.

attempt

integer

Which try this is. 1 for a run submitted directly; 2 or more for one produced by POST /v1/evaluations/{evaluation_id}/retry. There is a ceiling, so a clip that keeps failing under the same instructions stops being retryable rather than being retried forever.

Required range: x >= 1

timing

object | null

How long this run took. NULL when nothing was measured -- which is every run settled before it was recorded, and is not backfillable. Null and never 0. A run whose latency nobody recorded and a run that took no time are different claims, and only one of them is true. NOT in required, for the same reason error is not: during a rolling deploy some tasks are still the older build, and a response from one of those carries no such key. A client that enforces the contract at runtime -- the Python one does -- would raise on those responses, and it would raise only during a deploy, which is the worst time to be debugging a client. Test for a VALUE, not for the key.

Show child attributes

metadata

object | null

Whatever you passed on create, echoed back. NULL when you passed nothing -- the key is always present, its value says whether there was any. Only found by submitting through the API. Every evaluation created in the console carries metadata, so a contract checked against console traffic alone looked correct here.

⌘I

Retrieve an evaluation

curl --request GET \
  --url https://api.physionlabs.ai/v1/evaluations/{evaluation_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.physionlabs.ai/v1/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://api.physionlabs.ai/v1/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://api.physionlabs.ai/v1/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.physionlabs.ai/v1/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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "evaluation",
  "model": "galileo",
  "model_version": "<string>",
  "output_schema_version": "<string>",
  "created": 1,
  "status": "queued",
  "input": {
    "prompt": "<string>",
    "video": {
      "duration_sec": 1,
      "width": 2,
      "height": 2,
      "fps": 123,
      "num_frames": 2
    }
  },
  "usage": {
    "video_seconds": 1,
    "billable_units": 1
  },
  "result": {
    "glitches": [
      {
        "id": "<string>",
        "type": "visual_glitch",
        "description": "<string>",
        "source": "model",
        "region": {
          "start": {
            "frame": 1,
            "sec": 1,
            "timecode": "<string>"
          },
          "end": {
            "frame": 1,
            "sec": 1,
            "timecode": "<string>"
          },
          "boxes": [
            {
              "frame": 1,
              "sec": 1,
              "box": {
                "xmin": 0.5,
                "ymin": 0.5,
                "xmax": 0.5,
                "ymax": 0.5
              }
            }
          ]
        }
      }
    ],
    "summary": {
      "num_glitches": 1,
      "has_visual_glitch": true,
      "has_prompt_misalignment": true
    }
  },
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  },
  "detectors": [
    {
      "detector": "visual_glitch",
      "status": "pending",
      "error": {
        "code": "<string>",
        "message": "<string>"
      }
    }
  ],
  "video_id": "<string>",
  "attempt": 2,
  "timing": {
    "e2e_ms": 1
  },
  "metadata": {}
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

Getting started

Guides

SDKs

API reference

Resources

Authorizations

Path Parameters

Response