실행 작업(Job)은 워크플로우에 파일을 넣어 한 번 실행한 기록이에요. 실행 요청에서 받은 작업 ID를 저장하면 진행 상황과 결과를 나중에도 확인할 수 있습니다.
Python 예제는 시작하기의 client와 저장한 ID를 사용해요. cURL은 같은 흐름에서 받은 UPSTAGE_API_KEY, WORKFLOW_ID, CONFIG_ID, FILE_ID, JOB_ID 중 해당 작업에 필요한 값을 사용합니다.
설정을 선택하고 실행하기
워크플로우, 저장한 설정 버전, 준비가 끝난 파일이 필요해요. 워크플로우는 API로 생성하거나 Studio에서 만든 것을 사용할 수 있습니다.
model에는 워크플로우 ID(agt_...), config_id에는 사용할 설정 ID(cfg_...)를 넣어요. 설정 ID를 생략하면 가장 최신 버전이 아니라 기본으로 선택한 버전을 사용합니다. background=true(기본값)는 처리가 끝나기 전에 응답하므로 HTTP 200을 받아도 실행 성공 여부는 따로 확인해야 해요. 스트리밍을 사용하지 않을 때 background=false를 지정하면 완료까지 기다립니다.
진행 상황과 결과 확인하기
작업을 한 번 조회해 현재 상태와 마지막 단계의 결과(include=last)를 확인해요. 아직 실행 중이면 잠시 후 같은 작업 ID로 다시 조회하세요.
| 상태 | 의미 |
|---|---|
in_progress, cancelling | 실행·취소 처리 중이므로 계속 조회해요. |
completed | 완료되었으므로 output을 읽어요. |
failed, cancelled | 실패 또는 취소로 종료됐어요. error가 있으면 확인하세요. |
include=all을 사용하면 마지막 단계뿐 아니라 모든 단계의 결과를 볼 수 있습니다. output의 각 항목 안에 content가 있고, output_text 종류의 결과는 text에 담겨요. 추가 정보가 있으면 additional_values에도 JSON 문자열로 담기므로, 각 필드를 따로 json.loads로 읽습니다.
이전 실행 찾기
config_id, status, 생성 시각으로 좁힐 수 있어요. ts_from 이상, ts_to 미만이며 시각은 Unix 초 단위입니다. has_more가 true이면 last_id를 다음 요청의 after에 넣으세요. 필터와 정렬 순서는 동일하게 유지합니다.
진행 중인 실행 취소하기
취소 요청 후에도 종료 상태가 될 때까지 조회하세요. cancelling은 아직 취소 처리 중이라는 뜻이에요. 취소가 적용되기 전에 작업이 완료될 수 있고, 완료된 처리를 되돌리지는 않습니다.
실행 기록 삭제하기
삭제하면 실행 기록과 결과가 지워져요. 실행 중이라면 먼저 취소하고 종료를 확인한 뒤 삭제하세요. 요청과 응답 필드는 Jobs 명세를 확인하세요.