Skip to content
Artbucket

A token for a feature's background job, done as you

POST
/api/v1/job-tokens
curl --request POST \
  --url http://localhost:3000/api/v1/job-tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "minutes": 240 }'

For a feature that carries on after you leave the page (a brand import’s Apply): made from your session only, for the feature Artbucket-Feature names, on in this project. It acts with exactly your access here, in this project only, until minutes pass, the job revokes it, or the feature is turned off. History names it after you. Connections doesn’t list it.

Any caller; the scope needed is checked on what it acts on.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

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

What the job is, as history names it after yours: “brand import”

string
>= 1 characters <= 80 characters
minutes

How long it works, at most; the job revokes it when done

integer
default: 240 >= 5 <= 720

Responses

Section titled “Responses”

201

Section titled “201”

The token, shown this once

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
token
required

Shown once. Send as Authorization: Bearer <token>

string
expiresAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
Examplegenerated
{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "token": "example",
    "expiresAt": "2026-04-15T12:00:00Z"
  }
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}