Submit Recipe Job

Developing

POST

/recipe/job/submit

Submits an asynchronous recipe job for one or more images. Returns a job_id which can be used to poll for status and fetch results.

Example:

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Example

{
    "type": "RECIPE",
    "data": {
        "recipe_ids": [
            "recipe-id-1"
        ],
        "asset_detail": [
            {
                "url": "https://acme.s3.aws.com/image.jpg",
                "meta_data": {
                    "product_id": "string",
                    "product_name": "string",
                    "image_id": "string"
                }
            }
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://us1-api.crop.photo/v1/recipe/job/submit' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "type": "RECIPE",
    "data": {
        "recipe_ids": [
            "recipe-id-1"
        ],
        "asset_detail": [
            {
                "url": "https://acme.s3.aws.com/image.jpg",
                "meta_data": {
                    "product_id": "string",
                    "product_name": "string",
                    "image_id": "string"
                }
            }
        ]
    }
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "id": "string",
    "poll": "/v1/recipe/job/poll/{job_id}",
    "result": "/v1/recipe/job/result/{job_id}",
    "isQueueUnderLoad": true
}

🟠400Invalid Input

🟠401Unauthorized

Modified at 2026-06-23 17:34:07

List Recipes

Poll Recipe Job Status