Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Blind Insight REST Token API
version: 10.22.0
description: End-to-end encrypted datastore
tags:
- name: Token
paths:
/api/token/:
post:
operationId: token_create
description: 'Create a new token for the user with the given email and password. On success,
returns a JSON web token which can be used in the `Authorization` header to make
API requests.
The response will be an JSON object with the access and refresh tokens.
**On the command line:**
```bash
blind token create --data ''{"email": "demo@example.com", "password": "pass1234"}''
```'
summary: Create a new token
tags:
- Token
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenObtainPair'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenObtainPair'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenObtainPair'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenObtainPair'
description: ''
/api/token/refresh/:
post:
operationId: token_refresh
description: 'Refresh an existing token. On success, returns a JSON web token which can be
used in the `Authorization` header to make API requests.
The response will be an JSON object with the new access token.
**On the command line:**
```bash
blind token refresh --data ''{"refresh": ""}''
```'
summary: Refresh a token
tags:
- Token
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefresh'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenRefresh'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenRefresh'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefresh'
description: ''
/api/token/verify/:
post:
operationId: token_verify
description: 'Verify an access or refresh token is valid.
The response will be an empty object if it is valid, or a 401 unauthorized error
if it is not.
**On the command line:**
```bash
blind token verify --data ''{"token": ""}''
```'
summary: Verify a token
tags:
- Token
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenVerify'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenVerify'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenVerify'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenVerify'
description: ''
components:
schemas:
TokenObtainPair:
type: object
properties:
email:
type: string
writeOnly: true
password:
type: string
writeOnly: true
access:
type: string
readOnly: true
refresh:
type: string
readOnly: true
required:
- access
- email
- password
- refresh
TokenVerify:
type: object
properties:
token:
type: string
writeOnly: true
required:
- token
TokenRefresh:
type: object
properties:
access:
type: string
readOnly: true
refresh:
type: string
writeOnly: true
required:
- access
- refresh
securitySchemes:
basicAuth:
type: http
scheme: basic
cookieAuth:
type: apiKey
in: cookie
name: sessionid
jwtAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-provenance:
method: harvested
publisher: BlindInsight
source: https://api.app.blindinsight.io/api/schema/
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)