Dashboards

Upload a profile image

Upload one image for a dashboard profile, then put the returned imageKey on the profile entry in settings.profiles and save the dashboard with PUT /dashboards/{dashboardId}. Uploading alone does not change the dashboard.

Send the file as multipart form data, for example -F 'image=@speaker.png'. Send exactly one JPEG, PNG, WebP or GIF image of up to 2 MB. The server checks the file's content, not its name or declared type.

Only people who can edit the dashboard can upload. Each user can upload up to 30 images in 10 minutes.

Errors

  • 400 when there is not exactly one file, or the file is not a JPEG, PNG, WebP or GIF of up to 2 MB: "Upload one JPEG, PNG, WEBP, or GIF image of up to 2 MB."
  • 404 when the dashboard does not exist or you cannot edit it.
  • 429 after 30 uploads in 10 minutes.
post/dashboards/{dashboardId}/profile-image

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/dashboards/{dashboardId}/profile-image
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

dashboardIdstring required

Id of the dashboard, as returned when it was created.

Response

Success

status'success'

success on every 2xx response.

Changes

No recorded changes to this operation across all 2 revisions of this API.