GET
/
orchestrate
/
runs
curl --request GET \
  --url http://localhost/api/v1/orchestrate/runs \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "limit": 123,
  "offset": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_id": "<string>",
      "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "failed_at": "2023-11-07T05:31:56Z",
      "cancelled_at": "2023-11-07T05:31:56Z",
      "llm_params": {
        "beam_width": 1,
        "decoding_method": "greedy",
        "include_stop_sequence": true,
        "length_penalty": {
          "decay_factor": 2,
          "start_index": 2
        },
        "max_new_tokens": 1,
        "min_new_tokens": 1,
        "random_seed": 2147483648,
        "repetition_penalty": 1.5,
        "return_options": {
          "generated_tokens": true,
          "input_parameters": true,
          "input_text": true,
          "input_tokens": true,
          "token_logprobs": true,
          "token_ranks": true,
          "top_n_tokens": 2
        },
        "stop_sequences": "[\" and \"]",
        "temperature": 1,
        "time_limit": 123,
        "top_k": 50,
        "top_p": 0.5,
        "truncate_input_tokens": 1,
        "typical_p": 0.505
      },
      "usage": {},
      "last_error": "<string>",
      "result": {},
      "guardrails": {
        "hap": {
          "input": {
            "enabled": true,
            "threshold": 123
          },
          "output": {
            "enabled": true,
            "threshold": 123
          },
          "mask": {
            "remove_entity_value": true
          }
        },
        "social_bias": {
          "input": {
            "enabled": true,
            "threshold": 123
          },
          "output": {
            "enabled": true,
            "threshold": 123
          },
          "mask": {
            "remove_entity_value": true
          }
        },
        "pii": {
          "input": {
            "enabled": true,
            "threshold": 123
          },
          "output": {
            "enabled": true,
            "threshold": 123
          },
          "mask": {
            "remove_entity_value": true
          }
        }
      },
      "agent_id": "<string>",
      "additional_parameters": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:10

Limit the number of results returned

Required range: x >= 1
​
offset
integer
default:0

Skip the first N results

Required range: x >= 0

Response

200
application/json

Successful Response

The response is of type object.