Skip to main content

Recipe Generator is an AI-powered tool for generating detailed recipes. It returns complete recipes with ingredients, instructions, prep time, cook time, and servings.

Project description

Recipe Generator API

Recipe Generator is an AI-powered tool for generating detailed recipes. It returns complete recipes with ingredients, instructions, prep time, cook time, and servings.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Recipe Generator API


Installation

Using pip:

pip install apiverve-recipegenerator

Using pip3:

pip3 install apiverve-recipegenerator

Configuration

Before using the recipe API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_recipegenerator.apiClient import RecipeAPIClient

# Initialize the client with your APIVerve API key
api = RecipeAPIClient("[YOUR_API_KEY]")

query = { "name": "chicken fajitas" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Recipe Generator API documentation is found here: https://docs.apiverve.com/ref/recipe. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_recipegenerator.apiClient import RecipeAPIClient

# Initialize the client with your APIVerve API key
api = RecipeAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "name": "chicken fajitas" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "name": "Chicken Fajitas",
    "description": "A flavorful and easy-to-make dish with marinated chicken, bell peppers, and onions, served with warm tortillas and your favorite toppings.",
    "ingredients": [
      "1.5 pounds boneless, skinless chicken breasts, sliced into strips",
      "1 red bell pepper, sliced",
      "1 green bell pepper, sliced",
      "1 yellow bell pepper, sliced",
      "1 large onion, sliced",
      "2 tablespoons olive oil",
      "1 packet (1 ounce) fajita seasoning",
      "1/2 cup water",
      "12 flour tortillas",
      "Optional toppings: sour cream, guacamole, salsa, shredded cheese, chopped cilantro"
    ],
    "instructions": "1. In a bowl, combine the chicken strips with fajita seasoning and water. Marinate for at least 15 minutes.\n2. Heat olive oil in a large skillet or cast-iron pan over medium-high heat.\n3. Add the chicken and cook until browned and cooked through, about 5-7 minutes.\n4. Add the bell peppers and onion to the skillet. Cook, stirring occasionally, until softened, about 5-7 minutes.\n5. Warm the tortillas according to package directions.\n6. Serve the chicken and vegetables in warm tortillas with your favorite toppings.",
    "prep_time": "15 minutes",
    "cook_time": "20 minutes",
    "servings": 4
  }
}

Error Handling

The API client provides comprehensive error handling through the RecipeAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_recipegenerator.apiClient import RecipeAPIClient, RecipeAPIClientError

api = RecipeAPIClient("[YOUR_API_KEY]")

query = { "name": "chicken fajitas" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except RecipeAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_recipegenerator.apiClient import RecipeAPIClient, RecipeAPIClientError

api = RecipeAPIClient("[YOUR_API_KEY]")

query = { "name": "chicken fajitas" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except RecipeAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_recipegenerator.apiClient import RecipeAPIClient, RecipeAPIClientError

query = { "name": "chicken fajitas" }

# Using context manager ensures proper cleanup
with RecipeAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except RecipeAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_recipegenerator.apiClient import RecipeAPIClient

# Enable debug mode
api = RecipeAPIClient("[YOUR_API_KEY]", debug=True)

query = { "name": "chicken fajitas" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_recipegenerator.apiClient import RecipeAPIClient

api = RecipeAPIClient("[YOUR_API_KEY]")

query = { "name": "chicken fajitas" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_recipegenerator-1.1.14.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_recipegenerator-1.1.14-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_recipegenerator-1.1.14.tar.gz.

File metadata

File hashes

Hashes for apiverve_recipegenerator-1.1.14.tar.gz
Algorithm Hash digest
SHA256 cbce3da8c3ea07da3c62c4f4a1382d4b973c4cc7df5d34fce907503b337e90ec
MD5 06c0cbde5815a0f949183c3cd5550aa8
BLAKE2b-256 663910cce7f5c386a279a05c92d2eaa55901e1de0e579c5eaa56e2f5ca88b0db

See more details on using hashes here.

File details

Details for the file apiverve_recipegenerator-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_recipegenerator-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 9ca3bdc9cb4759199738f6cd5faa15586065a576119f1e21f55b04f42ab80db5
MD5 67c0570a91118f99058e7aa07a05adc4
BLAKE2b-256 8303a8ef525723c1177b5c3deacba5bc8878b618a58a39fb5ddef921677022cf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page