Async

Our API provides the capability to perform text generation asynchronously, allowing you to run jobs in the background and retrieve the results at a later time. This asynchronous approach is particularly useful when you have long-running or resource-intensive tasks that require more time to complete.

All the functionality from Visual To Text endpoint can be performed using Async endpoint.

Headers

The request should include the following header:

X-API-KEY: <Your API Key>

API Documentation: Asynchronous Text Generation

Endpoint:

https://api.axv.ai/api/generation/async/:format/:model/:content_id

Description: The Asynchronous Text Generation API allows you to perform text generation asynchronously by running jobs in the background. This approach is particularly useful for long-running or resource-intensive tasks, as it allows you to submit a generation request and retrieve the results at a later time.

Endpoint Details:

Method
Endpoint

POST

/api/generation/async/:format/:model/:content_id

Headers:

Key
Value

X-API-KEY

[Your API Key]

Endpoint Parameters:

Parameter
Description

:format

The format of the input. Either Image or Video.

:model

The specific model for text generation

:content_id

The unique identifier of the content. either image or video

Request Body:

The request body for the asynchronous text generation API endpoint should include the necessary parameters for the specific text generation task.

[Include any required parameters or data specific to your use case]

Response:

Upon successful submission of the generation request, you will receive a response with the following structure:

{
  "isSuccess": true,
  "message": "Process Started"
}

Retrieval Endpoint:

To retrieve the generated text asynchronously, make a separate API call to the retrieval endpoint, specifying the :content_id or job identifier.

Method
Endpoint

GET

/async

Please ensure to replace the placeholders in the endpoint URL and request body with the actual values specific to your implementation.

Last updated