Skip to main content
Retrieve the metadata of a specific agent by its ID.
External DocumentationTo learn more, visit the Helix documentation.

Parameters

ParameterDescription
IDThe ID of the agent. Can be obtained by the List Agents action.

Example Output

{
	"app_source": "helix",
	"config": {
		"allowed_domains": [
			"string"
		],
		"github": {
			"hash": "string",
			"key_pair": {
				"privateKey": "string",
				"publicKey": "string",
				"type": "string"
			},
			"last_update": {
				"error": "string",
				"hash": "string",
				"updated": "string"
			},
			"repo": "string",
			"webhook_secret": "string"
		},
		"helix": {
			"assistants": [
				{
					"apis": [
						{
							"description": "string",
							"headers": {
								"additionalProp": "string"
							},
							"name": "string",
							"query": {
								"additionalProp": "string"
							},
							"request_prep_template": "string",
							"response_error_template": "string",
							"response_success_template": "string",
							"schema": "string",
							"url": "string"
						}
					],
					"avatar": "string",
					"description": "string",
					"gptscripts": [
						{
							"content": "string",
							"description": "string",
							"file": "string",
							"name": "string"
						}
					],
					"id": "string",
					"image": "string",
					"is_actionable_template": "string",
					"lora_id": "string",
					"model": "string",
					"name": "string",
					"rag_source_id": "string",
					"system_prompt": "string",
					"tools": [
						{
							"config": {
								"api": {
									"actions": [
										{
											"description": "string",
											"method": "string",
											"name": "string",
											"path": "string"
										}
									],
									"headers": {
										"additionalProp": "string"
									},
									"query": {
										"additionalProp": "string"
									},
									"request_prep_template": "string",
									"response_error_template": "string",
									"response_success_template": "string",
									"schema": "string",
									"url": "string"
								},
								"gptscript": {
									"script": "string",
									"script_url": "string"
								}
							},
							"created": "string",
							"description": "string",
							"global": true,
							"id": "string",
							"name": "string",
							"owner": "string",
							"owner_type": "user",
							"tool_type": "api",
							"updated": "string"
						}
					],
					"type": ""
				}
			],
			"avatar": "string",
			"description": "string",
			"external_url": "string",
			"image": "string",
			"name": "string",
			"triggers": [
				{
					"cron": {
						"input": "string",
						"schedule": "string"
					},
					"discord": {
						"server_name": "string"
					}
				}
			]
		},
		"secrets": {
			"additionalProp": "string"
		}
	},
	"created": "string",
	"global": true,
	"id": "string",
	"owner": "string",
	"owner_type": "user",
	"shared": true,
	"updated": "string"
}

Workflow Library Example

Get Agent with Helix and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop