Generate Stunning 3D Models with the yosun/a100-shap-e Cognitive Actions

23 Apr 2025
Generate Stunning 3D Models with the yosun/a100-shap-e Cognitive Actions

In the realm of 3D modeling, the yosun/a100-shap-e Cognitive Actions provide a powerful toolset to generate 3D models from text prompts or synthetic view images. Leveraging advanced capabilities, this API allows developers to create visually striking models with customizable settings for rendering, resolution, and more. Using these pre-built actions not only expedites the development process but also enhances the creative potential of applications involving 3D content generation.

Prerequisites

Before diving into the Cognitive Actions, ensure you have the following:

  • API Key: To access the Cognitive Actions platform, you'll need a valid API key.
  • Setup: Familiarize yourself with the platform's authentication process. Generally, this involves passing the API key in the headers of your requests.

Cognitive Actions Overview

Generate 3D Model Using Shap-E

This action utilizes the Shap-E model to generate intricate 3D models based on either a text prompt or a synthetic view image URI. It enables various customizable parameters such as rendering mode, resolution, and guidance scale, with the option to save outputs as mesh files.

Input

The input schema for this action consists of several properties:

  • image (optional): A URI to a synthetic view image used for generating the 3D model. Ensure the background is removed for optimal results.
  • prompt (optional): The text prompt to generate the 3D model. This is ignored if an 'image' is provided.
  • saveMesh (optional): Indicates whether to save the latents as meshes (default: false).
  • batchSize (optional): The number of outputs to generate (default: 1).
  • renderMode (optional): Selects the rendering mode, which can be either 'nerf' or 'stf' (default: 'nerf').
  • renderSize (optional): Determines the resolution of the rendered output, where higher values increase rendering time (default: 128).
  • guidanceScale (optional): Specifies the scaling for guidance (default: 15).

Example Input:

{
  "prompt": "superhuman",
  "saveMesh": true,
  "batchSize": 1,
  "renderMode": "nerf",
  "renderSize": 128,
  "guidanceScale": 15
}

Output

The action typically returns URLs to the generated 3D model outputs, which may include various file formats (e.g., GIFs, OBJ files).

Example Output:

[
  "https://assets.cognitiveactions.com/invocations/1de30f2e-be9d-4e7f-87a6-ff35c6cd6d78/8dbcdcf6-5d5f-45e8-b83b-e3c9aba01ab3.gif",
  "https://assets.cognitiveactions.com/invocations/1de30f2e-be9d-4e7f-87a6-ff35c6cd6d78/19abc131-c0c5-432d-a2ca-5bad2bc512ab.obj"
]

Conceptual Usage Example (Python)

Here’s a conceptual Python code snippet demonstrating how to invoke the Generate 3D Model Using Shap-E action:

import requests
import json

# Replace with your Cognitive Actions API key and endpoint
COGNITIVE_ACTIONS_API_KEY = "YOUR_COGNITIVE_ACTIONS_API_KEY"
COGNITIVE_ACTIONS_EXECUTE_URL = "https://api.cognitiveactions.com/actions/execute" # Hypothetical endpoint

action_id = "ac6a067a-3af6-4b46-9e0f-587ffb5fd969" # Action ID for Generate 3D Model Using Shap-E

# Construct the input payload based on the action's requirements
payload = {
    "prompt": "superhuman",
    "saveMesh": True,
    "batchSize": 1,
    "renderMode": "nerf",
    "renderSize": 128,
    "guidanceScale": 15
}

headers = {
    "Authorization": f"Bearer {COGNITIVE_ACTIONS_API_KEY}",
    "Content-Type": "application/json"
}

try:
    response = requests.post(
        COGNITIVE_ACTIONS_EXECUTE_URL,
        headers=headers,
        json={"action_id": action_id, "inputs": payload} # Hypothetical structure
    )
    response.raise_for_status() # Raise an exception for bad status codes (4xx or 5xx)

    result = response.json()
    print("Action executed successfully:")
    print(json.dumps(result, indent=2))

except requests.exceptions.RequestException as e:
    print(f"Error executing action {action_id}: {e}")
    if e.response is not None:
        print(f"Response status: {e.response.status_code}")
        try:
            print(f"Response body: {e.response.json()}")
        except json.JSONDecodeError:
            print(f"Response body: {e.response.text}")

In this example, replace YOUR_COGNITIVE_ACTIONS_API_KEY with your actual API key. The snippet demonstrates how to structure the input payload and send a request to the hypothetical execution endpoint.

Conclusion

The yosun/a100-shap-e Cognitive Actions empower developers to create stunning 3D models efficiently. By using the actions outlined, you can seamlessly integrate 3D modeling capabilities into your applications, whether for gaming, virtual reality, or other creative projects. Consider experimenting with different prompts and parameters to uncover the full potential of these actions in your development efforts!

← Back to All Articles