Introduction – Applydesignapidocs

The Apply Design API gives you full access to many of the operations you can execute from the official Apply Design platform.

This documentation describes all of the available API calls and properties of the returned objects. If you have any questions, please reach out to info@applydesign.io.

The API endpoints have a rate limit of one call every two seconds per endpoint, regulated by API key.

Pagination

Some of our endpoints can be paginated.

Paginated endpoints can be called with Page and PageSize as query parameters. Here’s an example of a paginated call response:

Response Body

[
  {
    "ID": 180027,
    "Name": "1",
    "ResultImageURL": "https://url.jpeg",
    "ThumbnailURL": "https://url.jpg",
    "Status": "completed"
  },
  {
    "ID": 195439,
    "Name": "2",
    "ResultImageURL": "https://url.jpg",
    "ThumbnailURL": "https://url.jpg",
    "Status": "completed"
  }
]

Response Headers

content-range: items 1-2/3 
content-type: application/json; charset=utf-8 
date: Sun,28 May 2023 11:13:34 GMT 
links: {"nextPage":"https://localhost:44334/v1/images/renders?Page=2&PageSize=2","previousPage":null,"firstPage":"https://localhost:44334/v1/images/renders?Page=1&PageSize=2","lastPage":"https://localhost:44334/v1/images/renders?Page=2&PageSize=2"}

Understanding API responses

Example error response

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Item Not Found",
  "status": 404,
  "traceId": null,
  "errors": {
    "errorMessage": "Encountered an issue: Image not found"
  }
}

General API responses

General Errors

Code	Reason	Possible Next Step
401	Authorization Error	Make sure you are using a valid and active API key
500	General Server Error	Make sure our servers are up and running by calling the health endpoint

If you need further help, info@applydesign.io