Get account

GET

/v1/me

const url = 'https://reignitor.com/v1/me';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reignitor.com/v1/me \
  --header 'Authorization: Bearer <token>'

Returns the account that owns the API key, and its current credit balance. Use it to check that a key works before you start a render.

Authorizations

apiKey

Responses

200

The key is valid.

application/json

object

user_id

required

string format: uuid

email

string format: email

name

The account’s first name, if set.

string | null

credits_remaining

required

The account’s current credit balance.

number

Example

{
  "user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21",
  "email": "dev@example.com",
  "name": "Sam",
  "credits_remaining": 42
}

401

The key is missing, malformed, unknown or revoked.

application/json

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

Examples

No key, or not an emp_ key

{
  "error": "Unauthorized",
  "code": "NO_API_KEY"
}

Unknown or revoked key

{
  "error": "Invalid or revoked API key",
  "code": "INVALID_API_KEY"
}

402

The key is valid but the account is not on the Agency plan.

application/json

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

Example

{
  "error": "API access is part of the Agency plan.",
  "code": "PLAN_UPGRADE_REQUIRED",
  "feature": "api_access",
  "plan": "pro"
}

403

The account that owns the key is suspended.

application/json

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

Example

{
  "error": "Account suspended",
  "code": "ACCOUNT_SUSPENDED"
}

500

Something went wrong on our side.

application/json

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

Example

{
  "error": "Something went wrong handling that request."
}