v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
AI Model Suggestions

Get a generation run

Returns the status of a specific generation run. Poll until status is terminal (complete or failed), then re-fetch the suggestions list. Requires organization admin permissions.

get/api/v1/models/{modelId}/suggestions/runs/{runId}

Path parameters

modelIdstring uuid required

UUID of the shared model the run belongs to

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

UUID of the shared model the run belongs to

runIdstring uuid required

UUID of the generation run

Example:b2c3d4e5-f6a7-8901-bcde-f12345678901

UUID of the generation run

Response

The generation run

completedAtstring date-time nullable required

ISO 8601 timestamp when the run reached a terminal state.

createdAtstring date-time required

ISO 8601 timestamp when the run was created (queued).

errorobject nullable required

Failure details when status is failed; null otherwise.

executionStartedAtstring date-time nullable required

ISO 8601 timestamp when the worker started executing; null while queued.

idstring uuid required

The run id.

status'queued' | 'executing' | 'complete' | 'failed' required

Run status. Terminal states are complete and failed.

triggerSource'manual' | 'scheduled' required

Whether the run was triggered manually or by the schedule.