External Roles

List External Roles

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

sort_bystring[]OptionalDefault: []

limitinteger · max: 200OptionalDefault: 50

continuation_tokenanyOptional

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenanyOptional

422

Validation Error

application/json

get/v1/{workspace_id}/external-roles

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/external-roles HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "external_name": "text",
      "description": "text",
      "created_at": "2026-07-10T20:59:27.496Z",
      "updated_at": "2026-07-10T20:59:27.496Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Create External Role

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

namestring · min: 1 · max: 64RequiredPattern: ^[a-z][a-z0-9_]{0,63}$

external_namestring · min: 1 · max: 256Required

descriptionstring · max: 2048 · nullableOptional

Responses

201

Successful Response

application/json

Wire shape for read + create responses.

idstring · uuidRequired

namestringRequired

external_namestringRequired

descriptionstring · nullableOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

409

An external role with the given name already exists

422

Validation Error

application/json

post/v1/{workspace_id}/external-roles

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/external-roles HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "name": "text",
  "external_name": "text",
  "description": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "external_name": "text",
  "description": "text",
  "created_at": "2026-07-10T20:59:27.496Z",
  "updated_at": "2026-07-10T20:59:27.496Z"
}

Get External Role

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

role_idstring · uuidRequired

Responses

200

Successful Response

application/json

Wire shape for read + create responses.

idstring · uuidRequired

namestringRequired

external_namestringRequired

descriptionstring · nullableOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

404

External role not found

422

Validation Error

application/json

get/v1/{workspace_id}/external-roles/{role_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/external-roles/{role_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "external_name": "text",
  "description": "text",
  "created_at": "2026-07-10T20:59:27.496Z",
  "updated_at": "2026-07-10T20:59:27.496Z"
}

Delete External Role

delete

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

role_idstring · uuidRequired

Responses

204

Successful Response

No content

404

External role not found

422

Validation Error

application/json

delete/v1/{workspace_id}/external-roles/{role_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/external-roles/{role_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content