info

Get Feature Info

Get detailed information for a specific feature/subfeature.

Args: feature: Feature name (e.g., 'text', 'image', 'ocr', 'translation') subfeature: Subfeature name (e.g., 'ai_detection', 'ocr', 'generation') format: Schema output format (simplified or json_schema)

Returns: - Feature and subfeature display names - Request body schema (where the input fields and the model go) - Input schema - Output schema - Available providers and their models

get/v3/info/{feature}/{subfeature}

Request

  • Base URL
    https://api.edenai.run
  • Auth
    none declared

Path parameters

featurestring required
subfeaturestring required

Query parameters

format'simplified' | 'json_schema'

Output format for schema information.

Schema format: 'simplified' for flat readable format, 'json_schema' for full Pydantic JSON Schema

zero_data_retentionboolean nullable

true keeps only models whose provider keeps no prompts or outputs after the response (Zero Data Retention); false keeps only those known to keep them. Models not verified yet (zero_data_retention: null) match neither.

Response

Successful Response

featurestring required
feature_fullnamestring required
subfeaturestring required
subfeature_fullnamestring required
descriptionstring nullable
mode'sync' | 'async' required
endpointsobject required
request_schemaobject required

Schema of the request body sent to endpoints.create. The fields of input_schema go inside its input field, and model takes one of the models ids.

input_schemaobject required
output_schemaobject required
modelsobject[] required

Models available for this subfeature: the model id to send, its pricing and regions, and documentation_url, the provider's documentation for that model (the model's own page when there is one, else the feature's, else the provider's; null when none is known). requires_reference_images is true for an edit-only model, which fails on a request without reference_images, and requires_video for a model that edits a source video, which fails without video.

provider_paramsobject nullable

The provider_params each provider accepts, for subfeatures that restrict them; any other parameter is rejected with 400. Each entry is a parameter path in the provider's own request format, nested keys joined with dots (e.g. videogenerationconfig.seed), matched case-insensitively: send the keys in the provider's own casing ({"videoGenerationConfig": {"seed": 7}}). An empty list means the provider accepts none; null on subfeatures that publish no list.

Changes

No recorded changes to this operation across all 1 revision of this API.