AI Compute API

You need an API token to make requests to Image Processing API.

Instructions are available in the Obtaining an API Key section.

Introduction

This reference is your key to a comprehensive understanding of the Image Processing API.

Conventions

The base URL to send all API requests is https://processing.studio.liftdata.ai.

HTTPS is required for all API requests.

Pagination

By default, API returns ten items per call. If the number of items in a response from a support endpoint exceeds the default, then an integration can use pagination to request a specific set of the results and/or to limit the number of returned items.

Request Limits

To ensure a consistent developer experience for all API users, the API is rate limited and basic size limits apply to request parameters.

Rate Limits

Rate-limited requests will return a "rate_limited" error code (HTTP response status 429). The rate limit for incoming requests is set to 1000 requests per account. Rate limit is only applied to Create image processing request endpoint.

In the future, we plan to adjust rate limits to balance for demand and reliability. If you want to increase your rate limit please contact LIFT’s support team.

Status Codes

HTTP response codes are used to indicate general classes of success and error.

Success Code

HTTP Status Code	Description
200	Successfully processed request.
201	Successfully processed request.

Error Codes

Error responses contain more detail about the error in the response body, in the "detail" property.

HTTP Status Code	detail
401	Not authenticated
404	Resource is not found
422	Will contain information about exactly which fields are missing in the request body
429	Too many requests

Endpoints

Endpoint	Method	URL	Description
Image Processing Request	POST	/requests	Creates a processing request for an image send in the request body
Query Extracted Data	GET	/requests/models/%model_id%	Returns a paginated list of data extracted from the images

Obtaining an API Key

To obtain an API key:

1. Visit the Studio at https://studio.liftdata.ai

2. Navigate to the API Key section

3. Click on the New Key button and name your key

4. Copy and save your API key as you won’t be able to see it once the pop-up is closed