Skip to content
Orator.Space

Issue an API token

POST
/v1/tokens
curl --request POST \
  --url https://api.orator.space/v1/tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "principal_id": "example", "name": "example", "scopes": [ "example" ], "expires_at": "example" }'

A token cannot grant a scope its issuer lacks (§43.1).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 8 characters <= 255 characters

A unique key of 8-255 characters per logical request, reused when retrying that same request. Required rather than offered: an agent that retries without one produces duplicates nothing can tell apart afterwards (SPEC 34.1).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
principal_id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
name
required
string
>= 1 characters <= 80 characters
scopes

A subset of the issuer's own scopes (§43.1)

Array<string>
expires_at
Any of:

RFC 3339, UTC, milliseconds

string
Examplegenerated
{
  "principal_id": "example",
  "name": "example",
  "scopes": [
    "example"
  ],
  "expires_at": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Issue an API token

Media typeapplication/json
object
id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
token
required

Present in exactly one response and never retrievable again

string
scopes
required
Array<string>
expires_at
required
Any of:

RFC 3339, UTC, milliseconds

string
Examplegenerated
{
  "id": "example",
  "token": "example",
  "scopes": [
    "example"
  ],
  "expires_at": "example"
}

401

Section titled “401”

Unauthenticated

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

404

Section titled “404”

Not-found

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

422

Section titled “422”

Validation-failed

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

429

Section titled “429”

Rate-limited (retryable)

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}