Skip to content

Create an API token

POST
/v1/me/tokens
curl --request POST \
--url https://shareout.site/v1/me/tokens \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "regenerate": true }'

Mints a personal token, returned once. Body optional; { "regenerate": true } first revokes all of the caller’s existing tokens.

Media typeapplication/json
object
regenerate
boolean
Examplegenerated
{
"regenerate": true
}

Created

Media typeapplication/json
object
ok
boolean
token
string
shown_once
boolean
Examplegenerated
{
"ok": true,
"token": "example",
"shown_once": true
}

Authentication required

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
"success": false,
"support": {
"how": "POST /v1/support/tickets",
"include": [
"request_id"
]
}
}