Check your API's compatibility with AI
Get free report
7
Blog
Manifest
Careers
Talk to sales
API Checker Report
AI compatibility of Petstore API
The Petstore API is the number one OpenAPI model. But how does this mock API stands when it comes to AI? Does it structures has something to teach us?
Read more reports ->
Petstore AI analysis results
Overall appreciation
The API documentation is well-structured and covers many essential aspects.
Main areas of improvements
Endpoint Descriptions
Ensure all endpoints have comprehensive descriptions.
Intended Use Cases & Guidance
Enhance the visibility and clarity of use cases.
Pagination
Implement and document pagination for endpoints that return collections.
Details of the rating criteria
CRITERIA
DESCRIPTION
SCORE
BLOBR COMMENT
Required Parameters
Documentation must include the required parameters.
14
14
/15
Most endpoints have required parameters documented. Some might be missing this information.
Numerous and described endpoints
For each endpoint, the parameters for filtering information must be numerous and include descriptions.
9
9
/10
While many endpoints provide parameters with descriptions and formats/types, some might lack comprehensive information.
Operation IDs
Documentation must include operation IDs.
5
5
/5
All endpoints have the operationId attribute present.
Endpoint Descriptions
Documentation must include a clear and unambiguous description of each endpoint and data point.
12
12
/15
Some endpoints have clear descriptions, while others either lack descriptions or have very brief ones.
Data Model Clarity
Data model must be clear so that it can be used to make multiple calls from different endpoints.
10
10
/10
Most endpoints have required parameters documented. Some might be missing this information.
Use Cases
The use cases that can be created must be obvious.
7
7
/10
There are some clear use cases defined, but there's room for improvement to ensure comprehensive use case coverage.
Analytics Endpoints
Analytics endpoint must be available to answer analytics-related questions.
0
0
/10
No evident analytics-related endpoints.
Heaviness of Data Payload
Data payload and answers should not be too heavy, to avoid hallucinations.
8
8
/10
The data model appears lean without heavy data structures.
Authentication Description
The API support authentication mechanisms, to ensure that the LLM can access the data it needs while maintaining security.
0
0
/5
No authentication mechanism identified.
Pagination
Data payload must be paginated and detailed in the specifications.
0
0
/5
No evident pagination parameters in the endpoints.
Check the AI-compatibility of your API
Share your API specifications and get a free report on how to leverage AI with your API.
Get a personalized report
Petstore use cases
Pet Lookup
USER QUERY
Can you find information about my pet with ID 123?
AI ACTION
Calls GET /pet/{petId} with {petId} set to 123.
RESPONSE
Sure, your pet is a 2-year-old Golden Retriever named Max.
Pet Image Upload
USER QUERY
I want to upload a new picture of my pet with ID 123.
AI ACTION
Calls POST /pet/{petId}/uploadImage with {petId} set to 123 and the image data.
RESPONSE
Successfully uploaded the new image of your pet.
Pet Status Search
USER QUERY
Show me all pets that are available for adoption.
AI ACTION
Calls GET /pet/findByStatus with status set to available.
RESPONSE
Here are the pets that are available for adoption: [List of pets]
Store Inventory Check
USER QUERY
How many pets do you currently have in the store?
AI ACTION
Calls GET /store/inventory.
RESPONSE
We currently have 50 pets in the store.
Order Status Lookup
USER QUERY
What's the status of my order with ID 789?
AI ACTION
Calls GET /store/order/{orderId} with {orderId} set to 789.
RESPONSE
Your order with ID 789 is currently in processing.
USER QUERY
AI ACTION
RESPONSE
Ready to enhance the experience of your Product ?
Talk to sales
Great! You will receive an email very soon.
Oops! Something went wrong while submitting the form.
