API Details
Generates comprehensive API metadata including schemas, examples, suitability assessment, and more from a natural language description. Designed for LLM-backed API generation workflows.
Request Schema
| Property | Type | Required | Description |
|---|---|---|---|
description | string | required | A detailed description of the API's functionalities and use cases. |
Response Schema
| Property | Type | Required | Description |
|---|---|---|---|
tags | string[] | required | Keywords or tags that categorize the API. |
title | string | required | The formal name of the API in Title Case. |
prompt | string | optional | A brief statement describing the API's functionality. |
reason | string | required | Explanation for the suitability assessment, including criteria met/not met and suggestions if unsuitable. |
endpoint | string | required | URL-friendly endpoint name in kebab-case. |
examples | object[] | required | Example request/response pairs demonstrating API usage. |
request | object | required | Sample request matching the request_schema. |
response | object | required | Sample response matching the response_schema. |
categories | string[] | required | Predefined categories the API falls under. |
industries | string[] | required | Industry sectors the API targets. |
description | string | required | Detailed description of what the API does, including features, benefits, and use cases. |
suitability | boolean | required | Whether the API endpoint is suitable for LLM-backed implementation. True if the API can work with LLM's pre-trained knowledge only. |
request_schema | object | required | JSON Schema for the API request body. |
response_schema | object | required | JSON Schema for the API response body. |