API Keys

Get Api Keys

get

Get all API keys registered to the user

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

fidstringRequiredExample: apikey_abc123456

namestringRequired

created_atstring · datetimeRequiredExample: 2024-01-01T00:00:00Z

expires_atstring · datetimeRequiredExample: 2024-01-01T00:00:00Z

deactivated_atstring · datetime · nullableOptionalExample: 2024-01-01T00:00:00Z

snippetstringRequiredExample: fkey_abc1...

401

Invalid credentials

get/v2/api-keys

HTTPcURLJavaScriptPython

GET /v2/api-keys HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "fid": "apikey_abc123456",
    "name": "text",
    "created_at": "2024-01-01T00:00:00Z",
    "expires_at": "2024-01-01T00:00:00Z",
    "deactivated_at": "2024-01-01T00:00:00Z",
    "snippet": "fkey_abc1..."
  }
]

Create Api Key

post

Create a new API key

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

expires_atstring · datetimeRequiredExample: 2024-01-01T00:00:00Z

Responses

201

Successful Response

application/json

fidstringRequiredExample: apikey_abc123456

namestringRequired

created_atstring · datetimeRequiredExample: 2024-01-01T00:00:00Z

expires_atstring · datetimeRequiredExample: 2024-01-01T00:00:00Z

deactivated_atstring · datetime · nullableOptionalExample: 2024-01-01T00:00:00Z

snippetstringRequiredExample: fkey_abc1...

secretstringRequiredExample: fkey_abc123456

400

Invalid request parameters

401

Invalid credentials

422

Validation Error

application/json

post/v2/api-keys

HTTPcURLJavaScriptPython

POST /v2/api-keys HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "expires_at": "2024-01-01T00:00:00Z"
}

{
  "fid": "apikey_abc123456",
  "name": "text",
  "created_at": "2024-01-01T00:00:00Z",
  "expires_at": "2024-01-01T00:00:00Z",
  "deactivated_at": "2024-01-01T00:00:00Z",
  "snippet": "fkey_abc1...",
  "secret": "fkey_abc123456"
}

Revoke Api Key

delete

Revoke an API key

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

key_fidstringRequiredExample: apikey_abc123456

Responses

204

Successful Response

No content

400

Invalid request

401

Invalid credentials

404

API key not found

422

Validation Error

application/json

delete/v2/api-keys/{key_fid}

HTTPcURLJavaScriptPython

DELETE /v2/api-keys/{key_fid} HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content