Sign in

v1

latestSwagger 2.02026-07-176096209.1 KB
v2

Initiate an Asynchronous request to interrogate an image

This endpoint will immediately return with the UUID of the request for interrogation. This endpoint will always be accepted, even if there are no workers available currently to fulfill this request. Perhaps some will appear in the next 20 minutes. Asynchronous requests live for 20 minutes before being considered stale and being deleted.

post/v2/interrogate/async

Headers

apikeystring required

A User API key

Client-Agentstring

The client name and version

X-Fieldsstring mask

An optional fields mask

Request body

source_imagestring

The public URL of the image to interrogate.

slow_workersboolean

When True, allows slower workers to pick up this request. Disabling this incurs an extra kudos cost.

webhookstring

Provide a URL where the AI Horde will send a POST call after each delivered generation. The request will include the details of the job as well as the request ID.

Example request

{
  "forms": [
    {
      "name": "caption"
    }
  ],
  "webhook": "https://haidra.net/00000000-0000-0000-0000-000000000000"
}

Response

Interrogation Queued

idstring

The UUID of the request. Use this to retrieve the request status in the future.

messagestring

Any extra information from the horde about this request.