Delete Recipe

Endpoint Overview

POST /api/v1/ai-playground/delete-recipe

Description

This API endpoint enables you to permanently delete a specific recipe that you have previously created in the AI Playground. The deletion is performed by providing the unique recipe identifier. Once deleted, the recipe cannot be recovered, so ensure you have backed up any important recipe configurations before proceeding with deletion.

Key Benefits

Clean up your recipe inventory by removing obsolete or unused recipes

Maintain organization of your AI Playground workspace

Ensure compliance with data retention policies by removing unnecessary data

Simplify recipe management with straightforward deletion functionality

Use Cases

Software Development

Content Management

Enterprise

Remove test recipes created during development cycles

Clean up deprecated recipe versions after updates

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	Bearer token authentication using JWT token
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
recipe_id	String	Yes	The unique identifier of the recipe you want to delete

Example Request

{
    "recipe_id": "recipe_tqYliYdmednIMdcgdHlo"
}

Process Response

Response Parameters

Parameter	Type	Description
data	null	No data is returned for successful deletion operations
status_code	Integer	HTTP status code indicating the result of the operation
message_code	String	A code representing the outcome of the request
message	String	Human-readable description of the operation result
success	Boolean	Indicates whether the operation was successful

Example Successful Response

{
    "data": null,
    "status_code": 200,
    "message_code": "success",
    "message": "Success",
    "success": true
}

Possible Error Responses

Recipe Not Found

Authentication Error

Permission Error

{
    "data": null,
    "status_code": 404,
    "message_code": "recipe_not_found",
    "message": "The specified recipe could not be found",
    "success": false
}

This error occurs when the provided recipe_id does not exist in your account.

Integration Best Practices

Security Recommendations

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

Implement confirmation prompts before deletion to prevent accidental data loss

Maintain audit logs of deletion operations for security tracking

Rotate authentication credentials regularly

User Experience Guidelines

Provide clear feedback to users when a recipe is successfully deleted

Implement a confirmation step before deletion to prevent accidental data loss

Consider implementing a "soft delete" in your application before permanent deletion

Display meaningful error messages that help users understand and resolve issues

Code Samples

cURL

Python

Node.js

Related APIs

Create Recipe: Create new AI recipes in the AI Playground

List Recipes: Retrieve a list of all recipes you have created

Get Recipe: Retrieve details of a specific recipe by ID

Update Recipe: Modify an existing recipe's configuration

Compliance and Legal Considerations

When deleting recipes, ensure you are in compliance with any data retention policies that may apply to your organization. Some industries require maintaining records for specific periods before deletion. Always verify your compliance requirements before implementing automated deletion processes.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ai-playground/delete-recipe' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "recipe_id": "recipe_tqYliYdmednIMdcgdHlo" }'

Delete Recipe

Delete Recipe#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Delete Recipe

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples