Create Agent Group

As an Organization Admin, create an agent group in your organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

As an Organization Admin, create an agent group: an agent identity owned by your organization, such as ShoppingBot, that you instantiate once per enrolled user.

Authenticate with an Organization Admin User API key, sent in the skyfire-api-key header. Keys belonging to Organization Admins are accepted; a MEMBER key, or any Agent API key, is rejected with 401.

The group is created in your organization, derived from the API key; there is no orgId field in the request body. A new group is active immediately and has no members. Enroll users with Enroll User in Agent Group, or create them straight into the group with Create Organization User.

Naming rules

  • name must be printable ASCII (letters, digits, space, and punctuation), 1 to 100 characters, with at least one non-space character. Other characters return 422.
  • Names are compared case-insensitively with whitespace trimmed and collapsed: ShoppingBot, shoppingbot, and Shopping Bot are treated as the same name. The stored name keeps the casing you send.
  • A group name must be unique among your organization's groups, and may not match the name of an active, ungrouped agent belonging to any user in your organization. Either collision returns 409.

Each enrolled user's instance of the group is a buyer agent whose display name is the group's name, so a seller sees ShoppingBot in the token's aid.name regardless of which user is acting.

Body Params
string
required
length between 1 and 100

Name of the group. Printable ASCII with at least one non-space character, 1 to 100 characters. Unique in your organization after case and whitespace folding, and may not match an active ungrouped agent's name. Member agents take this name. e.g. "ShoppingBot"

string
length ≤ 1000

Free-form description of what this agent does. At most 1000 characters.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json