Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Connections
Tools
Large Language Models (LLMs)
Evaluation Framework
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
- Orchestrate Agent
- Assistants Runs
- Custom Assistants
- watsonx Assistant
- External Chat Agents
- Message Threads
- Documents
- Vector Index
- Catalog Management
- Tenant Management
- Provisioning Lite
- Embed settings
- User Profiles
- Completions
- Background Tasks
- Auth
- Orchestrate Assistant
- Notifications
- IBM unique ID mapping
- Prompts
- Artifact Management
- Default Agent Settings
- all journey types
- Connections
- Tools
- Welcome Content
- LLM Analytics
- Internal Calls are listed over here
- Agents
- Agent Releases
- Agent Release Environments
- Agent Chat Starter Settings
- API Reference
- channel integration
- Knowledge-Bases
- Chat with Docs
- Toolkits
- Voice Configurations
- Models
- Model-Policy
- Credentials
- Teams Channel
- Twilio WhatsApp Channel
Legal notices
Assistants Runs
List Assistant Runs
GET
/
assistants
/
{assistant_id}
/
runs
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/assistants/{assistant_id}/runs \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Successful Response
The response is of type AssistantRun · object[]
.
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/assistants/{assistant_id}/runs \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"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": {}
}
]
Assistant
Responses are generated using AI and may contain mistakes.