Create an Agent.

Create an Agent.

application/json

Request Body required

agent object

Represents a Fixie Agent.

owner object

The owner of this Agent.

user object

Represents a single Fixie User.

email string

The email address for this user.

fullName string

The name of the user. This is only used for display purposes.

avatarUrl string

The URL of the avatar image for this user.

apiToken string

The user's API token. This is only populated when a user accesses their own account information.

subscriptions object[]

The subscriptions for this user.

Array [

]

team object

Represents a Fixie Team.

displayName string

The display name for this team.

description string

The description for this team.

avatarUrl string

The URL of the avatar image for this team.

members object[]

The members of this Team.

Array [

user object

The user that is a member of this Team.

email string

The email address for this user.

fullName string

The name of the user. This is only used for display purposes.

avatarUrl string

The URL of the avatar image for this user.

apiToken string

The user's API token. This is only populated when a user accesses their own account information.

subscriptions object[]

The subscriptions for this user.

Array [

]

role object

The user's role on the Team.

isAdmin boolean

True if the user is an admin for the team.

]

subscriptions object[]

The subscriptions for this team.

Array [

]

handle string required

A short handle for this Agent.

displayName string

The display name of this Agent.

description string

A description of this Agent.

moreInfoUrl string

A URL with more information about this Agent.

currentRevisionId string

The current Agent Revision ID used by this Agent.

published boolean

Whether this Agent is published. Published Agents may be accessed by unauthenticated users.

branded boolean

Whether this Agent's UI is branded with the "Powered by Fixie" logo.

teamId string

If specified, the agent will be created in the specified team. Otherwise, the agent will be owned by the user making the request.

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

agent object

Represents a Fixie Agent.

agentId string

The unique ID of this Agent.

owner object

The owner of this Agent.

user object

Represents a single Fixie User.

userId string

The unique user ID for this user.

This field should not be populated in client requests.

email string

The email address for this user.

fullName string

The name of the user. This is only used for display purposes.

avatarUrl string

The URL of the avatar image for this user.

created date-time

When this user was created.

This field should not be populated in client requests.

modified date-time

When this user was last modified.

This field should not be populated in client requests.

apiToken string

The user's API token. This is only populated when a user accesses their own account information.

lastLogin date-time

When this user last logged in.

This field should not be populated in client requests.

subscriptions object[]

The subscriptions for this user.

Array [

id string

The unique ID for this subscription.

type enum

Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]

The type of subscription this represents.

state enum

Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]

The state of this subscription.

description string

A description of this subscription.

created date-time

When this subscription was created. This may not represent when the subscription was active, due to backdating.

modified date-time

When this subscription was last modified.

startTime date-time

The timestamp when this subscription starts.

endTime date-time

The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.

]

team object

Represents a Fixie Team.

teamId string

The unique ID for this team.

This field should not be populated in client requests.

displayName string

The display name for this team.

description string

The description for this team.

avatarUrl string

The URL of the avatar image for this team.

members object[]

The members of this Team.

Array [

teamId string

The team ID.

user object

The user that is a member of this Team.

userId string

The unique user ID for this user.

This field should not be populated in client requests.

email string

The email address for this user.

fullName string

The name of the user. This is only used for display purposes.

avatarUrl string

The URL of the avatar image for this user.

created date-time

When this user was created.

This field should not be populated in client requests.

modified date-time

When this user was last modified.

This field should not be populated in client requests.

apiToken string

The user's API token. This is only populated when a user accesses their own account information.

lastLogin date-time

When this user last logged in.

This field should not be populated in client requests.

subscriptions object[]

The subscriptions for this user.

Array [

id string

The unique ID for this subscription.

type enum

Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]

The type of subscription this represents.

state enum

Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]

The state of this subscription.

description string

A description of this subscription.

created date-time

When this subscription was created. This may not represent when the subscription was active, due to backdating.

modified date-time

When this subscription was last modified.

startTime date-time

The timestamp when this subscription starts.

endTime date-time

The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.

]

role object

The user's role on the Team.

isAdmin boolean

True if the user is an admin for the team.

pending boolean

Whether the membership is pending acceptance of an invitation by the user.

created date-time

When this membership was created.

modified date-time

When this membership was last modified.

]

created date-time

When this team was created.

This field should not be populated in client requests.

modified date-time

When this team was last modified.

This field should not be populated in client requests.

subscriptions object[]

The subscriptions for this team.

Array [

id string

The unique ID for this subscription.

type enum

Possible values: [SUBSCRIPTION_TYPE_UNSPECIFIED, SUBSCRIPTION_TYPE_BUILDER, SUBSCRIPTION_TYPE_STARTER, SUBSCRIPTION_TYPE_PERFORMANCE, SUBSCRIPTION_TYPE_OTHER]

The type of subscription this represents.

state enum

Possible values: [SUBSCRIPTION_STATE_UNSPECIFIED, SUBSCRIPTION_STATE_ACTIVE, SUBSCRIPTION_STATE_CANCELED, SUBSCRIPTION_STATE_EXPIRED, SUBSCRIPTION_STATE_CANCEL_PENDING]

The state of this subscription.

description string

A description of this subscription.

created date-time

When this subscription was created. This may not represent when the subscription was active, due to backdating.

modified date-time

When this subscription was last modified.

startTime date-time

The timestamp when this subscription starts.

endTime date-time

The timestamp when this subscription ends. If this subscription is active and has not been canceled, it will renew at this time.

]

handle string required

A short handle for this Agent.

displayName string

The display name of this Agent.

description string

A description of this Agent.

moreInfoUrl string

A URL with more information about this Agent.

created date-time

The creation time of this Agent.

modified date-time

The last time this Agent was modified.

currentRevisionId string

The current Agent Revision ID used by this Agent.

published boolean

Whether this Agent is published. Published Agents may be accessed by unauthenticated users.

branded boolean

Whether this Agent's UI is branded with the "Powered by Fixie" logo.

{
  "agent": {
    "agentId": "string",
    "owner": {
      "user": {
        "userId": "string",
        "email": "string",
        "fullName": "string",
        "avatarUrl": "string",
        "created": "2024-03-07T22:56:07.895Z",
        "modified": "2024-03-07T22:56:07.895Z",
        "apiToken": "string",
        "lastLogin": "2024-03-07T22:56:07.895Z",
        "subscriptions": [
          {
            "id": "string",
            "type": "SUBSCRIPTION_TYPE_UNSPECIFIED",
            "state": "SUBSCRIPTION_STATE_UNSPECIFIED",
            "description": "string",
            "created": "2024-03-07T22:56:07.895Z",
            "modified": "2024-03-07T22:56:07.895Z",
            "startTime": "2024-03-07T22:56:07.895Z",
            "endTime": "2024-03-07T22:56:07.895Z"
          }
        ]
      },
      "team": {
        "teamId": "string",
        "displayName": "string",
        "description": "string",
        "avatarUrl": "string",
        "members": [
          {
            "teamId": "string",
            "user": {
              "userId": "string",
              "email": "string",
              "fullName": "string",
              "avatarUrl": "string",
              "created": "2024-03-07T22:56:07.895Z",
              "modified": "2024-03-07T22:56:07.895Z",
              "apiToken": "string",
              "lastLogin": "2024-03-07T22:56:07.895Z",
              "subscriptions": [
                {
                  "id": "string",
                  "type": "SUBSCRIPTION_TYPE_UNSPECIFIED",
                  "state": "SUBSCRIPTION_STATE_UNSPECIFIED",
                  "description": "string",
                  "created": "2024-03-07T22:56:07.895Z",
                  "modified": "2024-03-07T22:56:07.895Z",
                  "startTime": "2024-03-07T22:56:07.895Z",
                  "endTime": "2024-03-07T22:56:07.895Z"
                }
              ]
            },
            "role": {
              "isAdmin": true
            },
            "pending": true,
            "created": "2024-03-07T22:56:07.895Z",
            "modified": "2024-03-07T22:56:07.895Z"
          }
        ],
        "created": "2024-03-07T22:56:07.895Z",
        "modified": "2024-03-07T22:56:07.895Z",
        "subscriptions": [
          {
            "id": "string",
            "type": "SUBSCRIPTION_TYPE_UNSPECIFIED",
            "state": "SUBSCRIPTION_STATE_UNSPECIFIED",
            "description": "string",
            "created": "2024-03-07T22:56:07.895Z",
            "modified": "2024-03-07T22:56:07.895Z",
            "startTime": "2024-03-07T22:56:07.895Z",
            "endTime": "2024-03-07T22:56:07.895Z"
          }
        ]
      }
    },
    "handle": "string",
    "displayName": "string",
    "description": "string",
    "moreInfoUrl": "string",
    "created": "2024-03-07T22:56:07.895Z",
    "modified": "2024-03-07T22:56:07.895Z",
    "currentRevisionId": "string",
    "published": true,
    "branded": true
  }
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...