📘 Overview
This document provides a step-by-step guide for uploading a file, processing it, and retrieving the results using the API with Postman.

✅ Prerequisites
To use these collections, you will need:

 Postman installed
 client_id and client_secret credentials
 Download following files:
Postman collection
Postman environment
🧩 Setup
1️⃣ Import the Collection
Open Postman
Select "Collections"
Click "Import"
Import the file: CIN-PROD_Postman.json
2️⃣ Import the Environment
Select "Environments"
Click "Import"
Import the file: PROD.Postman_environment.json
3️⃣ Select the Environment
In the top-right corner, select the environment: CIN
🔐 Authentication , health check & available actions
4️⃣ Check API Health
Send the HealthCheck request (GET)
✅ Expected response: 200 OK with:
"Healthy"

5️⃣ Set Your Credentials
Open the Authorize request (POST)
Go to the Body tab
Set the following keys and values:
client_id: your client ID
client_secret: your client secret
6️⃣ Authenticate & check available actions
Run the Authorize request again (POST)
✅ Response: 200 OK
🧠 The token is automatically stored as environment variable — no need to copy it manually
Trigger "Retrieve available actions" request to get available actions (it will also check if authorization worked properly)
✅ Response: 200 OK eg:
[
  "image-description",
  "image-metadata-generation",
  "text-classification",
  "text-summarization",
  "image-classification",
  "image-embeddings",
  "text-embeddings",
  "named-entity-recognition-image",
  "named-entity-recognition-text"
]

📤 File Upload
7️⃣ Generate a Presigned URL
Currently we support only .jpg, .png files for images and .pdf for documents

Use the PresignedUrl request (GET)
In the Params, specify the file type using the contentType key
Image Example: contentType = image%2Fjpg
Document Example: contentType = application%2Fpdf
🔗 You can find a list of supported file types at: Technical information

✅ On success (200 OK), the response will contain:

presignedUrl – 📋 Copy this value; you'll need it in the next step
objectKey – 📋 Copy this value; you'll need it for "Execute the Action" step 9
8️⃣ Upload the File
Use the Upload file request (PUT)
The request URL will automatically use the presignedUrl from step 7
In the Body tab:
Select binary
Select the file you want to upload
Send request
✅ Response should be: 200 OK

⚙️ Execute the Action
9️⃣ Trigger Content Processing
Use the Content processing request (POST)
In the Body, insert the copied objectKey from step 7.
Example:
2.1 Valid object key eg. from step 7 and valid action from step 6
{
 "objectKeys": ["your-object-key-from-step-7"],
 "actions": ["image-description"]
}

💡 Each action may behave differently depending on the use case. Please refer to the documentation for more information.

✅ On success:

Response: 200 OK
Response body will include a processingId
🧠 The processingId is automatically stored as an environment variable
📥 Retrieve Processing Results
🔟 Get Results by Result ID
Use the Retrieve result by ID request (GET).

The processingId from Step 9 is automatically included in the request URL
You can also manually provide any valid processingId
✅ Response:

Status: 200 OK
Body: Contains the final result from the processed file
✅ Summary
🔐 Authenticate using the IDP - AUTH request
🧪 Check health using the HealthCheck request
📂 Upload Flow
Get presignedUrl and objectKey
Upload the file via PUT using the Upload file request
Trigger content processing with the Content processing request
Retrieve results using the Retrieve result by ID request with processingId