---
title: "Evaluation Key"
method: GET
path: "/gateway/evaluation-key"
tags: ["gateway"]
---

# Evaluation Key

`GET /gateway/evaluation-key`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/gateway/evaluation-key`
- Auth: HTTP bearer

Whether OS3 can use your organisation's evaluation key, and each vendor upstream's
evaluation key, and why not.

## Response `200`

Successful Response

- EvaluationKey: Whether OS3 can use your organisation's evaluation key, and each vendor upstream's.
  - `usable` boolean, required
  - `reason` string, nullable, required
  - `source` 'provider' | 'os3', required
  - `ready` object, required
  - `upstreams` UpstreamEvaluation[], required
    - `upstream_id` string, uuid, required
    - `name` string, required
    - `vendor` string, required
    - `usable` boolean, required
    - `reason` string, nullable, required

---

[API](https://skmtc.dev/os3robotics/apis/os3-api.md) - [All operations](https://skmtc.dev/os3robotics/apis/os3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/os3robotics/apis/os3-api/revisions/af32cd4f14bb?raw)