List Recipes

Endpoint Overview

GET /api/v1/ai-playground/list-recipe

Description

This endpoint retrieves a comprehensive list of all AI recipes created in your account. AI recipes are predefined configurations for AI processing tasks that include input parameters, model selection, and processing instructions. This API allows developers to access all available recipes for integration into applications, dashboards, or management interfaces.

Key Benefits

Quickly retrieve all available AI recipes in a single API call

Access detailed configuration information including input keys, model types, and attachment capabilities

Simplify recipe selection for AI processing workflows

Enable dynamic recipe selection in applications based on specific requirements

Use Cases

Manufacturing

Document Processing

Data Analysis

Retrieve machine learning recipes for quality control systems

Access configurations for processing machine readings and sensor data

Implement dynamic recipe selection based on production requirements

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	JWT Bearer token for authentication. Format: `Bearer <your_token>`
Content-Type	Yes	Set to `application/json`

Request Body

This endpoint does not require a request body as it's a GET request to retrieve all recipes.

Process Response

Response Parameters

Parameter	Type	Description
recipe_id	String	Recipe ID
keys	Object	Keys
description	String	Description
model	String	Model
name	String	Name
created_at	String	Created At (YYYY-MM-DD format)
tag	String	Recipe Tag
preference_type	String	Preference Type (optional)
pages	Array	List of page numbers
use_pdf	Boolean	Use PDF
doc_url	String	Document URL

Example Successful Response

{
    "data": [
        {
        "recipe_id": "recipe_fxwFeYqwpVzjunaDbAEM",
        "keys": {
            "name": "str",
            "member_id": "int",
            "phone": "str",
            "address": "str"
        },
        "description": "The image displays a student ID card from the Ingoude Academy. It includes details like name, member ID, phone number, and address.",
        "model": null,
        "name": "Student ID Card Details",
        "created_at": "2025-05-14",
        "tag": "general",
        "preference_type": "latency",
        "pages": [],
        "use_pdf": false,
        "doc_url": null
    },
        {
        "recipe_id": "recipe_fxwFeYqwpVzjugfyfgg",
        "keys": {
            "name": "str",
            "member_id": "int",
            "phone": "str",
            "address": "str"
        },
        "description": "The image displays a student ID card from the Ingoude Academy. It includes details like name, member ID, phone number, and address.",
        "model": null,
        "name": "Student ID Card Details",
        "created_at": "2025-05-14",
        "tag": "general",
        "preference_type": "latency",
        "pages": [],
        "use_pdf": false,
        "doc_url": null
    }

    ],
    "status_code": 200,
    "message_code": "success",
    "message": "Success",
    "success": true
}

Possible Error Responses

Authentication Error

Server Error

{
    "status_code": 401,
    "message_code": "unauthorized",
    "message": "Invalid or expired token",
    "success": false
}

This error occurs when the JWT token is missing, invalid, or expired.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement token refresh mechanisms to handle token expiration

Use HTTPS for all API communications to ensure data security

Implement proper error handling for authentication failures

User Experience Guidelines

Cache recipe lists when appropriate to reduce API calls and improve performance

Implement pagination in your UI when displaying large numbers of recipes

Provide filtering options based on model type, attachment support, or other criteria

Display meaningful descriptions to help users select the appropriate recipe

Code Samples

cURL

Python

Node.js

Related APIs

Create Recipe API: Create new AI processing recipes with custom configurations

Execute Recipe API: Process data using a specific recipe configuration

Update Recipe API: Modify existing recipe configurations

Delete Recipe API: Remove recipes that are no longer needed

Compliance and Legal Considerations

When using AI models through these recipes, ensure you comply with the terms of service for the underlying AI providers (OpenAI, Google, etc.). Different models may have different usage restrictions and data handling requirements. Additionally, ensure that any data processed through these recipes complies with relevant data protection regulations such as GDPR or CCPA.

{ "data": [ { "recipe_id": "recipe_fxwFeYqwpVzjunaDbAEM", "keys": { "name": "str", "member_id": "int", "phone": "str", "address": "str" }, "description": "The image displays a student ID card from the Ingoude Academy. It includes details like name, member ID, phone number, and address.", "model": null, "name": "Student ID Card Details", "created_at": "2025-05-14", "tag": "general", "preference_type": "latency", "pages": [], "use_pdf": false, "doc_url": null }, { "recipe_id": "recipe_fxwFeYqwpVzjugfyfgg", "keys": { "name": "str", "member_id": "int", "phone": "str", "address": "str" }, "description": "The image displays a student ID card from the Ingoude Academy. It includes details like name, member ID, phone number, and address.", "model": null, "name": "Student ID Card Details", "created_at": "2025-05-14", "tag": "general", "preference_type": "latency", "pages": [], "use_pdf": false, "doc_url": null } ], "status_code": 200, "message_code": "success", "message": "Success", "success": true }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

List Recipes

List Recipes#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

List Recipes

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples