REST API
Arcade’s REST API allows you to programmatically create Arcades from videos and interaction data.
Last updated
Was this helpful?
Arcade’s REST API allows you to programmatically create Arcades from videos and interaction data.
Last updated
Was this helpful?
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!
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
.
This API flow lets you programmatically create an Arcade from a video and a list of interaction events.
Method: POST
Endpoint: /generate-upload-url
URL: https://api.arcade.software/generate-upload-url
Method: PUT
URL: Use the uploadUrl
from Step 1
Binary video file (e.g. .webm
, .mp4
, or .mov
)
Method: POST
URL: https://api.arcade.software/arcades
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.
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)
Same as the create Arcade endpoint:
This completely replaces the Arcade’s video and interaction steps with the new content.