mirror of
https://github.com/SrIzan10/makesweet-api.git
synced 2026-05-01 10:55:14 +00:00
improve docs
This commit is contained in:
34
API.md
34
API.md
@@ -1,31 +1,37 @@
|
||||
Hello, good evening, and welcome, to makesweet's API!
|
||||
Here's how to use it:
|
||||
1. get a computer
|
||||
2. get curl
|
||||
3. send a POST request with things in it
|
||||
4. receive a response
|
||||
5. do whatever you want with it.
|
||||
How to use the makesweet api:
|
||||
|
||||
1. get a computer
|
||||
2. get curl
|
||||
3. send a POST request with things in it
|
||||
4. receive a response
|
||||
5. do whatever you want with it.
|
||||
|
||||
|
||||
examples (assuming MAKESWEET_API is set as env var):
|
||||
-------
|
||||
|
||||
send only text (use &text for more text)
|
||||
send only text (use &text for more text):
|
||||
```
|
||||
curl -X POST $MAKESWEET_API/make/heart-locket?text=hello -o hello.gif
|
||||
curl -H "Authorization: key" -XPOST https://api.makesweet.com/make/heart-locket?text=hello -o hello.gif
|
||||
```
|
||||
-------
|
||||
|
||||
send only images (for multiple images, repeat with another -F)
|
||||
send only images (for multiple images, repeat with another -F):
|
||||
```
|
||||
curl -X POST $MAKESWEET_API/make/heart-locket -F "images[]=@image.jpg" -o animation.gif
|
||||
curl -H "Authorization: key" -XPOST https://api.makesweet.com/make/heart-locket -F "images[]=@image.jpg" -o animation.gif
|
||||
```
|
||||
-------
|
||||
|
||||
send both text and images
|
||||
send both text and images:
|
||||
```
|
||||
curl -X POST $MAKESWEET_API/make/heart-locket?text=squirrel -F "images[]=@image.jpg" -o animation.gif
|
||||
curl -H "Authorization: key" -XPOST https://api.makesweet.com/make/heart-locket?text=squirrel -F "images[]=@image.jpg" -o animation.gif
|
||||
```
|
||||
-------
|
||||
|
||||
the default is images go before text, use &textfirst=1 to make text go first
|
||||
send stuff with text border:
|
||||
```
|
||||
curl -H "Authorization: key" -XPOST "https://api.makesweet.com/make/heart-locket?text=a+frog,%0Aa+very,+very+coolfrog&textborder=200" -F images=@frog.jpg -o frog.gif
|
||||
```
|
||||
-------
|
||||
|
||||
the default is images go before text, use &textfirst=1 to make text go first.
|
||||
|
||||
Reference in New Issue
Block a user