Skip to main content
POST
Shorten Prompt
Shorten returns text suggestions rather than generated media. It is asynchronous, so persist job_id and wait for completed before reading the output. Treat the returned prompts as suggestions. If you later submit one to Text to Image, apply model parameters using the image parameter matrix.

Authorizations

x-api-key
string
header
required

API key from the Legnext dashboard. Authorization: Bearer <key> is accepted as an alternative.

Body

application/json
prompt
string
required

Prompt to analyze.

Required string length: 1 - 8192
callback
string<uri>

Optional webhook URL. When set, the completed TaskResponse is POSTed to this URL; when empty, poll GET /v1/job/{job_id}.

Response

Shorten task accepted.

config
object
required
detail
null
required

Reserved for future use; currently null in public API responses.

error
object
required
input
object
required

Echo of the task's input parameters (shape depends on task_type; mirrors the create-request body of the operation that created the task). Null in error responses.

job_id
string<uuid>
required

Task UUID. Pass it to GET /v1/job/{job_id} to poll, or reference it as jobId in follow-up operations.

logs
string[]
required

Operational log lines of the task (progress events, retries).

meta
object | null
required

Timestamps and billing usage of the task (null in error responses).

model
enum<string>
required

Model family that executed the task.

Available options:
midjourney
output
object
required

Task result, present once status is completed (null before that). Image/video tasks return URLs; describe/shorten tasks return text prompts.

status
enum<string>
required

Lifecycle state. Terminal states: completed, failed. staged means the task is queued behind the account's concurrency limit; retry means it is being resubmitted after a transient provider error.

Available options:
pending,
staged,
processing,
retry,
completed,
failed
task_type
enum<string>
required

Type of the task — the operation that created it.

Available options:
diffusion,
upscale,
reroll,
variation,
inpaint,
outpaint,
pan,
edit,
remix,
enhance,
upload_paint,
retexture,
remove_background,
shorten,
describe,
blend,
video_diffusion,
extend_video,
video_upscale,
enhance_upscale