Main Workflows

The Hautech API supports several core workflows that enable you to integrate its functionality into your application. This section explains four key workflows: uploading images, running asynchronous AI operations, tracking and limiting API usage for end users, and managing access to resources.

Upload Image

Uploading an image involves three API calls:

• Initialize Upload:
  Call the /v1/images/upload/initialize endpoint. This call returns a URL that will be used for the actual file upload.

  Example Request:

  curl -X POST "https://api.hautech.ai/v1/images/upload/initialize" \
   -H "Authorization: Bearer <your_jwt_access_token>"

• Actual File Upload:
  Use the URL received from the initialize call to upload your image using multipart/form-data. This call returns a file token that identifies the uploaded file.

  Example Request:

  curl -X PUT "https://upload.url.received/from/initialize" \
   -F "file=@/path/to/your/image.jpg"

• Finalize Upload:
  Call the /v1/images/upload/finalize endpoint with the file token from the previous step. This call returns an imageId that uniquely identifies your uploaded image.

  Example Request:

  curl -X POST "https://api.hautech.ai/v1/images/upload/finalize" \
   -H "Authorization: Bearer <your_jwt_access_token>" \
   -H "Content-Type: application/json" \
   -d '{"fileToken": "<your_file_token>"}'

Run Operations

All AI operations are asynchronous. To run an operation:

• Start the Operation:
  Initiate the desired AI operation by calling one of the endpoints under /v1/operations/run/*. The API will create a new operation with a status of "pending".

  Example Request:

  curl -X POST "https://api.hautech.ai/v1/operations/run/haute.linda.v1" \
   -H "Authorization: Bearer <your_jwt_access_token>" \
   -H "Content-Type: application/json" \
   -d '{"input": {"productImageId": <imageId>}}'

• Retrieve the Result:
  Once the operation has completed, retrieve the result by calling /v1/operations/{operationId}.

  Example Request:

  curl -X GET "https://api.hautech.ai/v1/operations/<ID>" \
   -H "Authorization: Bearer <your_jwt_access_token>"

API Usage Tracking and Limiting

To track and limit API usage by end users, follow these steps:

• Create an End User Account:
  Use the POST /v1/accounts endpoint to create a new account for the end user.

  Example Request:

  curl -X POST "https://api.hautech.ai/v1/accounts" \
   -H "Authorization: Bearer <your_jwt_access_token>" \
   -H "Content-Type: application/json" \
   -d '{"alias": "enduser@example.com"}'

• Add Credits to the Account:
  Use the PUT /v1/accounts/{id}/balance endpoint to add credits to the account.

  Example Request:

  curl -X PUT "https://api.hautech.ai/v1/accounts/{id}/balance" \
   -H "Authorization: Bearer <your_jwt_access_token>" \
   -H "Content-Type: application/json" \
   -d '{"amount": 100}'

• Sign a JWT for the User Account:
  Generate a self-signed JWT using your App credentials specifically for the end user. Important: Include only the relevant permissions; do not use a global wildcard (i.e., "*") as this would grant access to sensitive endpoints such as accounts and balances.

• Make Calls Using the Self-Signed Token:
  The end user should use the self-signed token to authenticate their API calls.

Access Management

By default, all resources (images, collections, operations, stacks, etc.) are visible and modifiable only by the creator account. To share access with other users, you can use the following techniques:

• Access Grant:
  Use the access/grant method to assign a specific permission to an account or group. For example, you can directly share an image with another user account.

• Access Attach:
  Use the access/attach method to allow inherited access. For instance, when an image is added to a collection, all users with access to that collection gain access to the image.

• Groups:
  Create groups to add multiple accounts as members and share access to resources with the entire group.