---
title: "Get Orchestrate Assistant Run"
method: GET
path: "/v1/orchestrate/runs/{run_id}"
tags: ["Orchestrate Agent"]
---

# Get Orchestrate Assistant Run

`GET /v1/orchestrate/runs/{run_id}`

## Path parameters

- `run_id` string, required

## Response `200`

Successful Response

- AssistantRun
  - `id` string, uuid, required
  - `tenant_id` string, nullable
  - `assistant_id` string, uuid, nullable
  - `thread_id` string, uuid, required
  - `status` 'pending' | 'running' | 'completed' | 'async_wait' | 'async_completed' | 'failed' | 'cancelled' | 'requires_input' | 'expired'
  - `created_at` string, date-time, nullable
  - `started_at` string, date-time, nullable
  - `completed_at` string, date-time, nullable
  - `failed_at` string, date-time, nullable
  - `cancelled_at` string, date-time, nullable
  - `llm_params` TextGenerationParameters
    - `beam_width` integer, nullable
    - `decoding_method` 'greedy' | 'sample'
    - `include_stop_sequence` boolean, nullable
    - `length_penalty` LengthPenalty
      - `decay_factor` number, nullable
      - `start_index` integer, nullable
    - `max_new_tokens` integer, nullable
    - `min_new_tokens` integer, nullable
    - `random_seed` integer, nullable
    - `repetition_penalty` number, nullable
    - `return_options` TextGenerationReturnOptions
      - `generated_tokens` boolean, nullable
      - `input_parameters` boolean, nullable
      - `input_text` boolean, nullable
      - `input_tokens` boolean, nullable
      - `token_logprobs` boolean, nullable
      - `token_ranks` boolean, nullable
      - `top_n_tokens` integer, nullable
    - `stop_sequences` string[], nullable
    - `temperature` number, nullable
    - `time_limit` integer, nullable
    - `top_k` integer, nullable
    - `top_p` number, nullable
    - `truncate_input_tokens` integer, nullable
    - `typical_p` number, nullable
  - `usage` object, nullable
  - `last_error` string, nullable
  - `result` object, nullable
  - `guardrails` GuardrailsOutput
    - `hap` Guardrail
      - `input` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `output` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `mask` MaskProperties
        - `remove_entity_value` boolean
    - `social_bias` Guardrail
      - `input` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `output` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `mask` MaskProperties
        - `remove_entity_value` boolean
    - `pii` Guardrail
      - `input` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `output` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `mask` MaskProperties
        - `remove_entity_value` boolean
  - `agent_id` string, nullable
  - `additional_parameters` object, nullable
  - `trace_id` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ibm/apis/wxo-server-api.md) · [All operations](https://skmtc.net/ibm/apis/wxo-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibm/wxo-server-api/revisions/82c114c37196/schema)