Submit Inference APIs
The Submit Inference APIs allow you to submit and manage your AI solutions. This suite includes the following primary endpoints:
Summary
- Submit/Get/Update/Delete API Configuration: Manage your API configurations and billing information efficiently.
- Update/Get Source Open API Specification: Update your source Open API specifications to ensure your API users know how to use it.
- Estimate Cost: Estimate cost and play with different billing mechanisms before publishing.
- Get Public Open API Specification: Retrieve the public Open API specifications for reference and integration.
Endpoints Section
Submit A New API
This endpoint and method create a new Inference API. The newly created API is in draft mode and requires review and publication before it can be made public. The handle and version identify the API. The system will increase the version number if the handle and version already exist.
Endpoint | /utils/inferences/v1 |
---|---|
Method | POST |
Tags | platform, inferences |
API Playground | Click Here |
# This tab is intentionally left blank.
Get An API
This endpoint and method get an Inference API, which is identified by its ID. If the API is not published, set the preview query parameter to true. If the key is needed, set the showKey query parameter to true.
Endpoint | /utils/inferences/v1/{id} |
---|---|
Method | GET |
Tags | platform, inferences |
API Playground | Click Here |
# This tab is intentionally left blank.
Update An API
This endpoint and method update an Inference API identified by its id. If the API is published, only a few fields can be updated. The publish query parameter is used to request review and publication.
Endpoint | /utils/inferences/v1/{id} |
---|---|
Method | PUT |
Tags | platform, inferences |
API Playground | Click Here |
# This tab is intentionally left blank.
Delete An API
This endpoint and method delete an Inference API identified by its id. If the API is published, it can not be deleted immediately. There is a 7-day grace period for the deletion. After the grace period, the API is unmounted permanently. If the API is not published, it is disabled immediately.
Endpoint | /utils/inferences/v1/{id} |
---|---|
Method | DELETE |
Tags | platform, inferences |
API Playground | Click Here |
# This tab is intentionally left blank.
Clone An API
This endpoint and method clone an Inference API, which is identified by its ID. The new API version is the next available version. If the API is not published, set the preview query parameter to true. If the key is needed, set the showKey query parameter to true.
Endpoint | /utils/inferences/clone/v1/{id} |
---|---|
Method | GET |
Tags | platform, inferences |
API Playground | Click Here |
# This tab is intentionally left blank.
Update Source OAS
Update Source OpenAPI Spec of an inference API by id.
Endpoint | /utils/src-openapi-specs/v1/{id} |
---|---|
Method | PUT |
Tags | platform, src-openapi-spec |
API Playground | Click Here |
# This tab is intentionally left blank.
Get Source OAS
Get Source OpenAPI Specification with data include auth security key info of an inference API by id.
Endpoint | /utils/src-openapi-specs/with-data/v1/{id} |
---|---|
Method | GET |
Tags | platform, src-openapi-spec |
API Playground | Click Here |
# This tab is intentionally left blank.
API Cost Estimation By ID
This API provides minimum, maximum and estimated average cost of 1000 requests for an inference API. The inference API is identified by id. If the API is not published, it requires preview=true query parameter.
Endpoint | /utils/inferences/cost/v1/{id} |
---|---|
Method | POST |
Tags | platform, inferences, cost estimation |
API Playground | Click Here |
# This tab is intentionally left blank.
Get OpenAPI Spec By ID
This API provides the estimation and average cost of 1000 requests for an inference API, which is identified by id. If the API is not published, a preview=true query parameter is required.
Endpoint | /utils/openapi-specs/v1/{id} |
---|---|
Method | GET |
Tags | platform, openapi-spec, by id |
API Playground | Click Here |
# This tab is intentionally left blank.
Get A Call Example By API ID
Get a call example identified by the api id. Only owner, admin, and developer can access this endpoint. The API must under their account_id.
Endpoint | /utils/call-examples/v1/{api_id} |
---|---|
Method | GET |
Tags | platform, call-examples, by api id |
API Playground | Click Here |
# This tab is intentionally left blank.
Update A Call Example
create a new call example or update an existing one identified by the api id. Only owner, admin, and developer can access this endpoint. The API must under their account_id.
Endpoint | /utils/call-examples/v1/{api_id} |
---|---|
Method | PUT |
Tags | platform, call-examples, by api id |
API Playground | Click Here |
# This tab is intentionally left blank.