Ai Images

List AI image jobs with pagination (Admin only)

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstring · enumOptionalPossible values:

jobTypestring · enumOptionalPossible values:

limitinteger · max: 100OptionalDefault: 50

offsetinteger · max: 2147483647OptionalDefault: 0

Responses

200

Successful response

application/json

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get/ai-images

HTTPcURLJavaScriptPython

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",
      "isSelected": true,
      "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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

jobIdinteger · max: 9007199254740991Required

Responses

200

Successful response

application/json

idnumberRequired

jobTypestring · enumRequiredPossible values:

entityIdnumberRequired

statusstring · enumRequiredPossible values:

isSelectedbooleanRequired

errorstring · nullableRequired

metadataany · nullableRequired

createdAtstringRequired

updatedAtstringRequired

completedAtstring · nullableRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get/ai-images/{jobId}

HTTPcURLJavaScriptPython

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",
  "isSelected": true,
  "error": "text",
  "metadata": null,
  "createdAt": "text",
  "updatedAt": "text",
  "completedAt": "text",
  "AiImages": [
    {
      "id": 1,
      "jobId": 1,
      "fileName": "text",
      "imageUrl": "text",
      "metadata": null,
      "createdAt": "text"
    }
  ]
}

List all AI image jobs for a specific entity (Admin only)

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

entityTypestring · enumRequiredPossible values:

entityIdinteger · max: 9007199254740991Required

Responses

200

Successful response

application/json

idnumberRequired

jobTypestring · enumRequiredPossible values:

entityIdnumberRequired

statusstring · enumRequiredPossible values:

isSelectedbooleanRequired

errorstring · nullableRequired

metadataany · nullableRequired

createdAtstringRequired

updatedAtstringRequired

completedAtstring · nullableRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get/ai-images/by-entity

HTTPcURLJavaScriptPython

GET /api/v2/ai-images/by-entity?entityType=SLASH&entityId=1 HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "jobType": "SLASH",
    "entityId": 1,
    "status": "PENDING",
    "isSelected": true,
    "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:

entityIdinteger · max: 9007199254740991Required

Responses

200

Successful response

application/json

idnumberRequired

jobTypestring · enumRequiredPossible values:

entityIdnumberRequired

statusstring · enumRequiredPossible values:

isSelectedbooleanRequired

errorstring · nullableRequired

metadataany · nullableRequired

createdAtstringRequired

updatedAtstringRequired

completedAtstring · nullableRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/ai-images/selected

HTTPcURLJavaScriptPython

GET /api/v2/ai-images/selected?entityType=SLASH&entityId=1 HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "id": 1,
  "jobType": "SLASH",
  "entityId": 1,
  "status": "PENDING",
  "isSelected": true,
  "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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

jobIdinteger · max: 9007199254740991Required

markAsSelectedbooleanOptionalDefault: false

promptOverridestringOptional

Responses

200

Successful response

application/json

jobIdnumberRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/ai-images/regenerate

HTTPcURLJavaScriptPython

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: 102

{
  "jobId": 1,
  "markAsSelected": false,
  "promptOverride": "text",
  "imageUrlOverrides": [
    "https://example.com"
  ]
}

{
  "jobId": 1
}

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

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

jobIdinteger · max: 9007199254740991Required

Responses

200

Successful response

application/json

successbooleanRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/ai-images/activate

HTTPcURLJavaScriptPython

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

jobIdinteger · max: 9007199254740991Required

Responses

200

Successful response

application/json

successbooleanRequired

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post/ai-images/retry

HTTPcURLJavaScriptPython

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
}