Jobs

JobService

Service which can be used to communicate with Job type in UGC API.

To use this service, you need to instantiate it with a valid Move UGC client.

from move_ugc import MoveUgc
ugc = MoveUgc(api_key="my-api-key")

# Call job service methods directly
ugc.jobs.retrieve(id="job-<guid>")

# Or use the job service as a mixin
job_service = ugc.jobs
job_service.retrieve(id="job-<guid>")

create

create(take_id: str, name: Optional[str] = '', metadata: Optional[Dict[str, Any]] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> JobType

Create a singlecam job in MoveUGC.

Parameters:

Name	Type	Description	Default
`take_id`	`str`	id of the take to be used for creating the job.	required
`name`	`Optional[str]`	name to be used for creating the job.	`''`
`metadata`	`Optional[Dict[str, Any]]`	metadata to be used for creating the job. This should be a valid json string.	`None`
`expand`	`Optional[List[ALLOWED_EXPAND_ATTRS]]`	list of fields to be expanded. Currently only `client`, `take` and `outputs` are supported.	`None`

Returns:

Type	Description
`JobType`	Job instance of Pydantic model type.

create_singlecam

create_singlecam(take_id: str, name: Optional[str] = '', metadata: Optional[Dict[str, Any]] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> JobType

Create a singlecam job in MoveUGC.

Parameters:

Name	Type	Description	Default
`take_id`	`str`	id of the take to be used for creating the job.	required
`name`	`Optional[str]`	name to be used for creating the job.	`''`
`metadata`	`Optional[Dict[str, Any]]`	metadata to be used for creating the job. This should be a valid json string.	`None`
`expand`	`Optional[List[ALLOWED_EXPAND_ATTRS]]`	list of fields to be expanded. Currently only `client`, `take` and `outputs` are supported.	`None`

Returns:

Type	Description
`JobType`	Job instance of Pydantic model type.

create_multicam

create_multicam(take_id: str, number_of_actors: int, options: Optional[JobOptions] = None, name: Optional[str] = '', metadata: Optional[Dict[str, Any]] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> JobType

Create a multicam job in MoveUGC.

Parameters:

Name	Type	Description	Default
`take_id`	`str`	id of the take to be used for creating the job.	required
`number_of_actors`	`int`	number of actors to be used for creating the job.	required
`options`	`Optional[JobOptions]`	options to be used for creating the job. Check all the valid allowed options in the API documentation. https://move-ai.github.io/move-ugc-api/schema/#optionsinput	`None`
`name`	`Optional[str]`	name to be used for creating the job.	`''`
`metadata`	`Optional[Dict[str, Any]]`	metadata to be used for creating the job. This should be a valid json string.	`None`
`expand`	`Optional[List[ALLOWED_EXPAND_ATTRS]]`	list of fields to be expanded. Currently only `client`, `take` and `outputs` are supported.	`None`

Returns:

Type	Description
`JobType`	Job instance of Pydantic model type.

retrieve

retrieve(id: str, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> JobType

Retrieve a job from MoveUGC.

Parameters:

Name	Type	Description	Default
`id`	`str`	id of the job to be retrieved.	required
`expand`	`Optional[List[ALLOWED_EXPAND_ATTRS]]`	list of fields to be expanded. Currently only `client`, `take` and `outputs` are supported.	`None`

Returns:

Type	Description
`JobType`	Job instance of Pydantic model type.

update

update(id: str, metadata: Optional[Dict[str, Any]] = None, name: Optional[str] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> JobType

Update a job with given job in MoveUGC.

Parameters:

Name	Type	Description	Default
`id`	`str`	unique identifier for the take. This should typically be something like `take-{uuid}`.	required
`metadata`	`Optional[Dict[str, Any]]`	metadata to be used for updating the take. This should be a valid json string.	`None`
`name`	`Optional[str]`	name to be used for updating the take.	`None`
`expand`	`Optional[List[ALLOWED_EXPAND_ATTRS]]`	list of fields to be expanded. Currently only `client`, `output`, `take` and `sources` are supported.	`None`

Returns:

Type	Description
`JobType`	Take instance of Pydantic model type.

list

list(limit: Optional[int] = None, next_token: Optional[str] = None, sort_by: SortDirection = SortDirection.DESC, take_id: Optional[str] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> ListBase

List jobs in MoveUGC.

Parameters:

Name	Type	Description	Default
`limit`	`Optional[int]`	limit the number of items to be returned.	`None`
`next_token`	`Optional[str]`	next token to be used for pagination.	`None`
`sort_by`	`SortDirection`	sort order for the list.	`DESC`
`take_id`	`Optional[str]`	id of the take to be used for filtering the jobs.	`None`
`expand`	`Optional[List[ALLOWED_EXPAND_ATTRS]]`	list of fields to be expanded. Currently only `client`, `take` and `outputs` are supported.	`None`

Returns:

Name	Type	Description
`ListBase`	`ListBase`	List of Job instances of Pydantic model type.