v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB

AI Gateway Consumer Groups

Add a Consumer to a Consumer Group

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Add a consumer to an AI Gateway Consumer Group.

post/v1/ai-gateways/{gatewayId}/consumer-groups/{consumerGroupId}/consumers

Request body

consumerstring required

The ID or name of the consumer to add to the group.

Example request

{
  "consumer": "cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b"
}

Response

Consumer added to consumer group successfully.

Example response

{
  "consumer": {
    "display_name": "Greg's Dev Consumer",
    "name": "my-entity-name",
    "custom_id": "dev-users",
    "labels": {
      "category": "finance"
    },
    "managed_by": {
      "owner": "terraform"
    },
    "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    "created_at": "2022-11-04T20:10:06.927Z",
    "updated_at": "2022-11-04T20:10:06.927Z"
  },
  "consumer_group": {
    "display_name": "Dev Users Group",
    "name": "my-entity-name",
    "labels": {
      "category": "finance"
    },
    "managed_by": {
      "owner": "terraform"
    },
    "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    "created_at": "2022-11-04T20:10:06.927Z",
    "updated_at": "2022-11-04T20:10:06.927Z"
  }
}