Create Organization User Buyer Agent

Changed on

As an Organization Admin, create an ungrouped buyer agent for an organization user, with a wallet and one API key.

post/api/v1/organizations/users/{userId}/agents/buyer

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/organizations/users/{userId}/agents/buyer
  • Auth
    API key in header skyfire-api-key

Path parameters

userIdstring uuid required

Unique identifier of the organization user. e.g. "906fc259-ef0a-4736-bdcd-c1d5a78db483"

Request body

displayNamestring required

Display name of the new agent, shown to sellers as aid.name. Printable ASCII with at least one non-space character, 1 to 100 characters. Must be free among the user's active agents and not match an active agent group in your organization. e.g. "Procurement Agent"

Response

Ok

idstring required

Unique identifier of the created agent.

apiKeystring required

API key for the agent. Returned only in this response and cannot be retrieved again, store it securely.

Changes