Actions31
- Agent Actions
- Attachment Actions
- Comment Actions
- Config Actions
- Dartboard Actions
- Doc Actions
- Folder Actions
- Help Center Article Actions
- Skill Actions
- Task Actions
- View Actions
Agent → Get Agent
AI-generatedSummary
Retrieve an existing agent by its ID, including its name and description
Inputs
- id (required) — Agent identifier
- requestOptions — Optional request customization collection (e.g., batching, SSL, proxy, timeout)
Output shape
single agent object containing fields such as id, name, description
Returns 200 with the agent data; if not found, a 404 response is returned with an error message
Examples
Example 1: Fetch details of the agent with ID 12345
id = 12345
Example 2: Fetch an agent while enabling batching with 100 items per batch and 500 ms interval
id = 9876, requestOptions.batching.batchSize = 100, requestOptions.batching.batchInterval = 500
Example 3: Retrieve an agent through a proxy with a 15 second timeout
id = abcde, requestOptions.proxy = http://proxy:3128, requestOptions.timeout = 15000