]> git.r.bdr.sh - rbdr/captura/blame_incremental - README.md
Save WIP -> Multimonitor change working
[rbdr/captura] / README.md
... / ...
CommitLineData
1# Captura
2
3Bring your own backend screen recorder
4
5## Bring Your Own Backend (Protocol version 1.0)
6
7Captura allows you to define a URL that will be used to POST the recording.
8
9### The Request
10
11A `POST` will be made to the request, with the payload containing the binary
12contents of the file. You can expect the following headers:
13
14* `User-Agent`: `Captura/1.0`
15* `Content-Type`: `video/mp4` or `image/gif`, depending on the output format
16 selected.
17
18### Authentication / Authorization
19
20We will only do a POST request, so if you need any type of keys or user
21identifiers, include them in the URL itself (eg. via path elements or
22in the query parameters)
23
24### Expected Response
25
26If the upload is successful, the response *MUST* be a JSON object containing
27a key called `url` with a value of type `string` corresponding to the URL
28where the file is available. The status code *MUST* be 201 Created.
29
30Any response code other than 201 Created will be treated as an error. Captura
31will not re-attempt an upload.