API Suitability Assessment

Public

API Details

This API allows developers to submit a proposed API description and receive an assessment of its suitability for implementation on the GenerationAPI platform based on predefined criteria. The API evaluates the proposed API against four specific criteria: LLM-Only Functionality, No External Data Access, Self-Contained Logical Processing, and Statelessness. It provides a comprehensive assessment of whether the proposed API meets these criteria, helping developers understand if their API concept is compatible with the GenerationAPI platform's capabilities and constraints.

Try it out Developer Docs

Request Schema

Property	Type	Required	Description
apiDescription	string	required	A detailed description of the API to be assessed

Response Schema

Property	Type	Required	Description
assessments	object[]	required	Detailed assessments for each criterion
criterion	string	optional	The name of the criterion assessed
assessment	string	optional	The result of the assessment for the criterion
meetsRequirement	boolean	optional	Indicates if the requirement for the criterion is met
meetsCriteria	boolean	required	Indicates whether the proposed API meets all the specified criteria

API Metadata

ID651

Version

Method

post

Endpoint

/api-suitability-assessment/v1

API Examples

Example Request

{
  "apiDescription": "An API that generates creative writing prompts based on user-provided themes or genres. It uses natural language processing to understand the input and produces unique, inspiring prompts for writers."
}

Example Response

{
  "assessments": [
    {
      "criterion": "LLM-Only Functionality",
      "assessment": "The API's functionality of generating creative writing prompts can be achieved solely through the language model's capabilities without requiring external resources.",
      "meetsRequirement": true
    },
    {
      "criterion": "No External Data Access",
      "assessment": "The API does not require access to external databases, websites, or APIs to generate prompts.",
      "meetsRequirement": true
    },
    {
      "criterion": "Self-Contained Logical Processing",
      "assessment": "Generating creative writing prompts is within the language model's reasoning and processing abilities and does not require complex computations.",
      "meetsRequirement": true
    },
    {
      "criterion": "Statelessness",
      "assessment": "Each prompt generation can be independent and does not rely on previous interactions or maintaining state across sessions.",
      "meetsRequirement": true
    }
  ],
  "meetsCriteria": true
}

Docs Edit