{% extends "base.html" %} {% block content %}
To start using the API you need an API key. {% if current_user.is_authenticated %} New keys can be generated using the form below. There is currently no limit to the number of API keys that can be issued.
API keys don't expire, however previously issued API keys can be made unusable by invalidating them.
HTTP POST to {{ url_for('api.upload', _external = True) }}
with the file to be uploaded in the file
field.
The regular URL {{ url_for('.upload', _external = True) }}
can also be used, but files uploaded via this URL can't be registered to your account as this requires a valid browser session.
cURL example:
$ curl -F file=@image.png {{ url_for('api.upload', _external = True) }}Returns the following JSON, which should be self-explanatory:
{ "hash": "hash", "status": true, "urls": { "base": "{{ url_for('.file', hash = '', _external = True) }}", "full": "{{ url_for('.file', hash = 'hash', filename = 'image.png', _external = True) }}", "ext": "{{ url_for('.file', hash = 'hash', ext = '.png', _external = True) }}", "hash": "{{ url_for('.file', hash = 'hash', _external = True) }}" } }
To register files to your account, the API key must be specified as the bearer token:
$ curl -H 'Authorization: Bearer api_key' -F file=@image.png {{ url_for('api.upload', _external = True) }}(Replace api_key with a generated API key)
By using the regular URL and adding api=1
you will get machine-readable responses in the form: response result
where response
is either ERROR
or OK
,
and result
is the file hash in the case of OK
, or an error message in the case of ERROR
.
The hash can be used to construct URLs in which the paths begin with {{ url_for('.file', hash = 'hash') }}
where hash
is the hash received.
Any file extension an be appended to the hash, and for convenience the original filename (or whatever filename you prefer) can be appended after an additional slash after the hash. See JSON response above for examples on how to construct URLs.
{% endblock %} {% block scripts %} {% endblock %}