Job
An asynchronous job (1.52.0; api-platform.md section 5). Poll it, or subscribe to job.succeeded and job.failed.
An object with 13 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_at | Timestamp | yes | |
created_by | ActorRef | yes | |
error | JobError or null | yes | Why the job failed, a code and a message; null otherwise. |
finished_at | Timestamp or null | yes | |
has_result_file | boolean | yes | True when the result is a file, fetched through POST /v1/jobs/{job_id}/result-url. |
id | JobId | yes | |
object | "job" | yes | |
progress | JobProgress | yes | |
resource | JobResource or null | yes | |
result | JobResult or null | yes | A small result inline once succeeded, typed by the job type (WebhookReplayJobResult for webhook.replay, from 1.53.0 KnowledgeEvaluationJobResult for knowledge.evaluation, from 1.55.0 PromptEvalRunJobResult for prompt.evaluation and agent.conversation_test, from 1.56.0 AnalysisJobResult for call.analyze); null before. |
started_at | Timestamp or null | yes | |
status | JobStatus | yes | |
type | JobType | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.