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: Clypmint Com Me API
version: 1.1.0
description: 'Operations tagged Me across 2 of this provider''s published API definitions: clypmint-com-openapi.json, clypmint-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://clypmint.com/api/v1
security:
- bearerAuth: []
tags:
- name: Me
paths:
/me:
get:
summary: Get the account profile, its credits and videos used this month
responses:
'200':
description: Profile
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
'400':
description: The request is invalid. The message names each field to fix.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: A valid bearer token (API key or OAuth access token) is required.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'402':
description: This account has no allowance left for this, or does not include it. error.checkout_url is where to add it.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: This needs publishing permission (scope clypmint.publish), or is not open on this account yet.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: The video, upload, memory or calendar was not found in this account.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: 'Busy: an upload or edit is already running, the video changed, or too many upload links are waiting.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'413':
description: The request body is too large.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Clypmint could not apply it as asked; error.problems names each part.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: A daily limit was reached (direct edits, caption fixes, upload links).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: This is not available on Clypmint yet; the message says what to use instead.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: Clypmint is busy. Try again in a moment.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Me
operationId: getMe
x-operation-id-source: derived
servers:
- url: https://clypmint.com/api/v1
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
message:
type: string
code:
type: string
description: A fixed code, e.g. plan_required or op_invalid.
checkout_url:
type: string
format: uri
description: 'On a 402: where to pick a plan or add credits.'
fields:
type: string
description: 'On a 400: each field and what is wrong with it.'
problems:
type: array
items:
type: object
required:
- message
required:
- error
Profile:
type: object
properties:
id:
type: string
name:
type:
- string
- 'null'
email:
type:
- string
- 'null'
plan:
type:
- string
- 'null'
can_create:
type: boolean
videos:
type: object
credits:
type:
- object
- 'null'
properties:
used:
type: number
included:
type: number
left:
type: number
upgrade_url:
type: string
format: uri
required:
- id
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API key or OAuth token
x-refined-from:
- clypmint-com-openapi.json
- clypmint-com-openapi.yml