API v1 Reference › Custom Agents

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

GEThttps://api.awork.com/api/v1/agents/{agentId}/configuration
GET https://api.awork.com/api/v1/agents/{agentId}/configuration

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.

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Path parameters

agentIdstringRequired
format: uuid

The agent id.

Responses

200 OK

application/json

agentIdstringOptional
format: uuid

The custom agent identifier.

enabledConnectorIdsarray of string or nullOptional

The ids of connectors linked to this agent. Chat connector choices do not change these links.

enabledSkillIdsarray of string or nullOptional

The ids of skills linked to this agent.

connectorConnectionsarray of object or nullOptional

One entry per shared or visible user-selected connector, with its account source and availability.

Show 5 properties
connectorIdstringOptional
format: uuid

The linked connector identifier.

selectedConnectionIdstring or nullOptional
format: uuid

The account this user explicitly chose for this agent and connector; null when no choice is saved.

defaultConnectionIdstring or nullOptional
format: uuid

The account the agent would try to use after applying the selection rules; null when none is selected. This may be a saved choice, an awork Agent default, or an editor-provided account. Check Status before treating the account as available.

connectionSourcestring or nullOptional

Why the account was selected: userSelection is this user's saved agent choice; personalDefault is their enabled awork Agent default; specificConnection is the editor-provided account; none means no account was selected.

statusstring or nullOptional

The account's availability: pending, connected, authRequired, error, or suspended. Missing means no account could be selected. Inaccessible means the user cannot use the connector or account.

401 Unauthorized

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

404 Not Found

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

Search documentation