RoutineRun Class

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Returns

Remove all items from D.

clear() -> None

copy() -> Model

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

items() -> ItemsView[str, Any]

Returns

keys() -> KeysView[str]

Returns

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values() -> ValuesView[Any]

Returns

The downstream action correlation identifier, when available.

action_correlation_id: str | None

The action type dispatched for the routine attempt. Known values are: "invoke_agent_responses_api" and "invoke_agent_invocations_api".

action_type: str | _models.RoutineActionType | None

The legacy endpoint-scoped agent identifier recorded for the routine attempt.

agent_endpoint_id: str | None

The project-scoped agent identifier recorded for the routine attempt.

agent_id: str | None

"event_fire", "manual_dispatch", "queued_dispatch", "schedule_delivery", and "timer_delivery".

attempt_source: str | _models.RoutineAttemptSource | None

The conversation identifier used by a responses API dispatch.

conversation_id: str | None

The dispatch identifier associated with the routine attempt.

dispatch_id: str | None

The time when the underlying run reached a terminal state.

ended_at: datetime | None

The truncated failure message captured for a failed attempt, when available.

error_message: str | None

The downstream error status code captured for a failed attempt, when available.

error_status_code: int | None

The fully qualified error type captured for a failed attempt, when available.

error_type: str | None

The unique run identifier for the routine attempt. Required.

id: str

"queued", "dispatching", "completed", and "failed".

phase: str | _models.RoutineRunPhase | None

The downstream response or invocation identifier, when available.

response_id: str | None

The scheduled fire time recorded for timer and schedule deliveries.

scheduled_fire_at: datetime | None

The hosted-agent session identifier used by an invocations API dispatch.

session_id: str | None

The time when the underlying run started.

started_at: datetime | None

str

status: _types.RoutineRunStatus | None

The workspace task identifier linked to the routine attempt, when available.

task_id: str | None

The event payload captured from the event that triggered the routine attempt, when available.

trigger_event_payload: dict[str, Any] | None

The configured trigger name that produced the routine attempt.

trigger_name: str | None

"custom", "github_issue", "schedule", and "timer".

trigger_type: str | _models.RoutineTriggerType | None

The logical trigger time recorded for the routine attempt.

triggered_at: datetime | None