Skip to content

get_import

Poll an import job by job_id. Pass workspace_id to look up a job_id known to live in a workspace other than your current one; omit it to search your current workspace plus every other workspace you belong to (OAuth/JWT sessions only).

read-only · idempotent

NameTypeRequiredDefaultDescription
job_idAnnotated[str, Field(description='UUID of the import job to check.')]Yes
workspace_id`Annotated[strNone, Field(description=ID_BACKED_WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • job_id (string)
  • status (string)
  • target_workspace_id (string)
  • target_repo_name (string)
  • message (string)

See the response example below for the full payload shape.

{
"name": "get_import",
"arguments": {
"job_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
}
}
{
"job_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
"status": "success",
"target_workspace_id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
"target_repo_name": "forecasts-imported",
"message": "Import completed."
}
  • Module: Imports
  • Requires authentication via API token or Auth0 JWT.