Plug Database Advanced icon

Plug Database Advanced

Run Plug Database commands over REST or Socket.

Actions26

Client Access → Get Client Token

AI-generated

Summary

Retrieve the client token associated with a specified Plug agent by its Agent ID, optionally including Plug metadata with the response.

Inputs

  • Agent ID (required) — Specify the unique identifier of the Plug agent for which to retrieve the client token.
  • Include Plug Metadata — Set to true to include the __plug object containing operation and pagination metadata in the response (default is true).

Output shape

a single record containing the client token details for the given Agent ID, optionally enriched with Plug metadata.

The response includes token data related to the specified agent. If Include Plug Metadata is enabled, additional metadata about the operation and pagination (if applicable) is included under the __plug property.

Examples

Example 1: Get the client token for a given agent by providing the Agent ID, with default metadata inclusion.

Agent ID: agent-12345; Include Plug Metadata: true

Links

Discussion