Async Jobs

Endpoint

https://api.axv.ai/api/generation/jobs

/api/generation/jobs

This endpoint allows you to retrieve a list of generation jobs. You can optionally apply filters to narrow down the results by status or tags. The endpoint supports a GET request method.

Headers

The request should include the following header:

X-API-KEY: <Your API Key>

Endpoint

GET https://api.axv.ai/api/generation/jobs

Example Request

GET https://api.axv.ai/api/generation/jobs?status=pending&tags=example-tag
X-API-KEY: YOUR_API_KEY

Example Response

{
  "isSuccess": true,
  "storeList": [
    {
      "_id": "648b2e0ba1b7c2f60c0ad611",
      "file_url": "https://storage.googleapis.com/download/storage/v1/b/fussydata/o/c6591737cae69e988792511afff6c0d8.png?generation=1683978098733758&alt=media",
      "tags": [],
      "generations": "The current image showcases a beautiful close-up shot of a vibrant plant flower petal, frozen in mid-air as if gracefully gesturing towards something. The details of the delicate petal are magnificently captured, revealing its intricate texture, vibrant colors, and natural beauty. This image is a mesmerizing sight that evokes a sense of awe and appreciation for the wonders of nature. Whether used as a background, a centerpiece, or simply enjoyed for its artistic value, this image is sure to add a touch of elegance and serenity to any space or project."
    },
    {
      "_id": "648b2e0ba1b7c2f60c0ad613",
      "file_url": "https://storage.googleapis.com/download/storage/v1/b/fussydata/o/ddc02a4e692d980c7d2fdbbf6c6ed67c.png?generation=1683978306545812&alt=media",
      "

Parameters

The endpoint accepts the following optional query parameters:

Parameter	Type	Description
status	string	Filters the jobs by their status. Possible values: "pending", "complete".
tags	string	Filters the jobs by user-defined tags.

Response

The API will respond with a JSON object containing the following properties:

Property	Type	Description
isSuccess	boolean	Indicates whether the request was successful or not.
storeList	array	An array of objects representing the generation jobs.
totalPages	number	The total number of pages available for the job list.
currentPage	number	The current page of the returned results.
totalStores	number	The total number of generation jobs available.

storeList Object Properties

Each object in the storeList array represents a generation job and has the following properties:

Property	Type	Description
_id	string	The unique identifier for the job.
file_url	string	The URL of the generated file.
tags	array	An array of tags associated with the job (empty if no tags are provided).
generations	string	A description of the generation or generated content associated with the job.

Note: The tags and generations properties might not be present for all jobs in the storeList.