Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
83 lines (58 sloc) 3.77 KB

The Image Relay API

The Image Relay API allows IR users to access many Image Relay features through a JSON RESTful web interface.

Making a Request

All requests start with https://[company url]

In curl a request would look like this:

curl -u user:pass -H 'User-Agent: MyApp ('

If you are sending data to the API, include the Content-Type header and the data as JSON.

curl -u username:password \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp (' \
  -d '{ "name": "New Catalog" }' \


To test things out and get started, you can use http basic authentication with the IR API. In production, you should use the supported oauth2 authentication. That way you don't have to worry about storing Image Relay usernames' and passwords' in your own application. Click [here] ( for more detailed information regarding oauth authentication.

Identify your app

You must include a User-Agent header with the name of your application and a link to it or your email address so we can get in touch in case you're doing something wrongor something great. Here's an example:

User-Agent: MyCompany (

If you don't supply this header, you will get a 400 Bad Request.

Rate limiting

You can perform up to 5 request/second from the same IP address. If you exceed this limit, you'll get a 429 Too Many Requests response for subsequent requests.




The actions you can access in the API are dependant upon the permission levels assigned to your Image Relay account. For instance, not all users are permitted to upload files or create folders, or see a list of users. If you find yourself receiving "401 Unauthorized" errors, please confirm your permission level with your Image Relay Administrator.

If you find a typo or an error in the documentation, we welcome pull requests.

If you have questions or trouble implementing the API, you can reach out to and we'll help you out. Need general help with Image Relay? Checkout our online support center.

Want to Chat?

Need help, have questions? Check out our developers slack channel.