API v1 ReferenceCustom Agents

Returns a custom agent's connection configuration for the current user.

Returns the linked connector and skill ids, the account selected for each connector, why that account was selected, and whether it is available. Uses a saved agent choice, or the enabled awork Agent default when no choice is saved. An editor-provided account is used when the connector has specificConnection mode. API-key requests do not inherit awork Agent defaults. This read does not save or change any choices. <Check title="Required Permissions" icon="key">The user must have read access to the agent.</Check>

Authentication

AuthorizationBearer

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

Path parameters

agentIdstringRequiredformat: "uuid"
The agent id.

Response

OK
agentIdstringOptionalformat: "uuid"
The custom agent identifier.
enabledConnectorIdslist of strings or nullOptional
The ids of connectors linked to this agent. A linked connector may still need a working account.
enabledSkillIdslist of strings or nullOptional
The ids of skills linked to this agent.
connectorConnectionslist of objects or nullOptional
One entry per linked connector, with this user's account choice, its source, and its availability.

Errors

401
Unauthorized Error
404
Not Found Error