Skip to content
Docs
Get early access

Create an API key (secret shown once)

POST
/v1/api-keys
curl --request POST \
--url https://api.wirevod.online/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "encoder-ci", "scopes": [ "write" ] }'
Media typeapplication/json
object
name
required
string
>= 1 characters <= 64 characters
scopes
required
Array<string>
>= 1 items
Allowed values: read write admin
Example
{
"name": "encoder-ci",
"scopes": [
"write"
]
}

API key created. The key value is returned only here.

Media typeapplication/json
object
id
required
string
name
required
string
prefix
required
string
scopes
required
Array<string>
Allowed values: read write admin
created_at
required
integer
key
required

Full secret key. Returned only at creation.

string
Example
{
"id": "key_01J9Z",
"name": "encoder-ci",
"prefix": "wvk_0a1b2c3d4e5f",
"scopes": [
"write"
],
"created_at": 1760000000000,
"key": "wvk_0a1b2c3d4e5f_0123456789abcdef0123456789abcdef0123456789abcdef"
}

The request was malformed or failed validation.

Media typeapplication/json
object
error
required
string
code
required
string
message
required
string
details
Example
{
"error": "invalid_request",
"code": "invalid_request",
"message": "asset_id is required"
}

Missing or invalid credentials.

Media typeapplication/json
object
error
required
string
code
required
string
message
required
string
details
Example
{
"error": "unauthorized",
"code": "unauthorized",
"message": "Authentication required"
}

The principal lacks the required scope or role.

Media typeapplication/json
object
error
required
string
code
required
string
message
required
string
details
Example
{
"error": "forbidden",
"code": "forbidden",
"message": "Missing required scope: write"
}

Too many requests in the current window.

Media typeapplication/json
object
error
required
string
code
required
string
message
required
string
details
Example
{
"error": "rate_limited",
"code": "rate_limited",
"message": "Too many requests",
"details": {
"retry_after": 60
}
}
Retry-After
integer

Seconds to wait before retrying.