OSos3robotics
gateway

Create Key

A key for your app (shown once, with its setup URL's key), or a judge key on an upstream. Your app's key reaches every provider: its requests carry your provider key, name an OS3 model, or go to your one saved provider key of their API; upstream_id pins it to one.

post/gateway/keys

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/keys
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

namestring required
workspace_idstring uuid nullable
upstream_idstring uuid nullable
purpose'traffic' | 'judge'
trace_policy'full' | 'metadata' | 'none' nullable
expires_atstring date-time nullable
evaluation_keyboolean

Response

Successful Response

idstring uuid required
namestring required
prefixstring required
workspace_idstring uuid nullable required
upstream_idstring uuid nullable required
os3_modelsboolean required
routing_mode'legacy' | 'auto' required
scopesstring[] required
trace_policystring required
purposestring required
vault_secretstring nullable required
created_atstring date-time required
expires_atstring date-time nullable required
keystring nullable required
url_keystring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.