Rate image

Queues a content rating for an image and returns the task. The result is a single level, so this is the cheap check to run before publishing something generated.

POST/image/rate
AuthAPI keyorOAuth tokenHow to send it

Headers

Idempotency-Keystring

Makes the create safe to retry. Send a unique value per logical request; a retry with the same key and body returns the original task instead of creating and charging a new one. The same key with a different body answers 409 idempotency_conflict. Up to 255 visible ASCII characters.

≤ 255 characters
X-Mynth-Clientstring

Names the client sending the request, such as sdk/1.4.0, cli or agent-prompt. It is only counted, never checked: a value that is not a short lowercase tag is ignored.

≤ 64 charactersmatches ^[a-z0-9@][a-z0-9@._/-]{0,63}$

Request body

urlstringrequired
format: uri
mode"nsfw_sfw"
default "nsfw_sfw"

Response

Image rating task created

dataobjectrequired
task_idstringrequired

Task ID

e.g. "tsk_01KE7XWWEQ4MCGWKBQKJ1G47RP"
estimated_coststringrequired

Estimated cost in USD reserved for this task. Work that fails is refunded, so the final cost may be lower.

e.g. "0.03"

Errors

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.