REST API
Arcade’s REST API allows you to programmatically create Arcades from videos and interaction data.
The Arcade API is actively being developed and subject to changes. Only a subset of what’s possible in the app is covered by the API. Let us know which features you want to see on the API first!
Authentication
How do I authenticate with the API?
First, generate an API key:
Go to
Settings > Advanced
in your Arcade team dashboard.Generate a new API key.
Then, include the API key in the authorization
header of all requests:
All requests are made to https://api.arcade.software
.
Creating an Arcade from a Video
This API flow lets you programmatically create an Arcade from a video and a list of interaction events.
Step 1: How do I generate an upload URL?
Method: POST
Endpoint: /generate-upload-url
URL: https://api.arcade.software/generate-upload-url
Headers:
Body:
Response:
Step 2: How do I upload the video?
Method: PUT
URL: Use the uploadUrl
from Step 1
Headers:
Body:
Binary video file (e.g. .webm
, .mp4
, or .mov
)
Step 3: How do I create the Arcade?
Method: POST
URL: https://api.arcade.software/arcades
Headers:
Body:
Notes:
Click events create hotspots.
Scroll and type events are used to determine if a video step should be created.
If there’s no scroll or type between clicks, the step will default to an image.
Response:
Replacing an Existing Arcade
Can I update an existing Arcade with a new video and event list?
Yes. Use the same flow as the creation endpoint, but instead of POST /arcades
, use a different method and endpoint.
Method: PUT
URL: https://api.arcade.software/arcades/:id
(Replace :id
with the ID of the Arcade you're updating)
Headers:
Body:
Same as the create Arcade endpoint:
This completely replaces the Arcade’s video and interaction steps with the new content.
Last updated
Was this helpful?