Ai Images

List AI image jobs with pagination (Admin only)

get
Authorizations
Query parameters
statusstring · enumOptionalPossible values:
jobTypestring · enumOptionalPossible values:
limitinteger · max: 100OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200
Successful response
application/json
get
GET /api/v2/ai-images HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "id": 1,
      "jobType": "SLASH",
      "entityId": 1,
      "status": "PENDING",
      "error": "text",
      "metadata": null,
      "createdAt": "text",
      "updatedAt": "text",
      "completedAt": "text",
      "AiImages": [
        {
          "id": 1,
          "jobId": 1,
          "fileName": "text",
          "imageUrl": "text",
          "metadata": null,
          "createdAt": "text"
        }
      ]
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get AI image job details (Admin only)

get
Authorizations
Path parameters
jobIdintegerRequired
Responses
200
Successful response
application/json
get
GET /api/v2/ai-images/{jobId} HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "jobType": "SLASH",
  "entityId": 1,
  "status": "PENDING",
  "error": "text",
  "metadata": null,
  "createdAt": "text",
  "updatedAt": "text",
  "completedAt": "text",
  "AiImages": [
    {
      "id": 1,
      "jobId": 1,
      "fileName": "text",
      "imageUrl": "text",
      "metadata": null,
      "createdAt": "text"
    }
  ]
}

Get selected AI image job for entity

get
Query parameters
entityTypestring · enumRequiredPossible values:
entityIdintegerRequired
Responses
200
Successful response
application/json
get
GET /api/v2/ai-images/selected HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "id": 1,
  "jobType": "SLASH",
  "entityId": 1,
  "status": "PENDING",
  "error": "text",
  "metadata": null,
  "createdAt": "text",
  "updatedAt": "text",
  "completedAt": "text",
  "AiImages": [
    {
      "id": 1,
      "jobId": 1,
      "fileName": "text",
      "imageUrl": "text",
      "metadata": null,
      "createdAt": "text"
    }
  ]
}

Regenerate AI image job (Admin only)

post
Authorizations
Body
jobIdintegerRequired
markAsSelectedbooleanOptionalDefault: false
Responses
200
Successful response
application/json
post
POST /api/v2/ai-images/regenerate HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "jobId": 1,
  "markAsSelected": false
}
{
  "jobId": 1
}

Activate AI image job as the image to use for an entity (Admin only)

post
Authorizations
Body
jobIdintegerRequired
Responses
200
Successful response
application/json
post
POST /api/v2/ai-images/activate HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "jobId": 1
}
{
  "success": true
}

Retry a failed AI image job (Admin only)

post
Authorizations
Body
jobIdintegerRequired
Responses
200
Successful response
application/json
post
POST /api/v2/ai-images/retry HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "jobId": 1
}
{
  "success": true
}
PreviousAuctionsNextApps