BYOK

List BYOK provider credentials

Authorization

bearerAuth

AuthorizationBearer <token>

API key in format: eur_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Query Parameters

offset?integer

Number of records to skip for pagination

Range-9007199254740991 <= value <= 9007199254740991

limit?integer

Maximum number of records to return (max 100)

Range-9007199254740991 <= value <= 9007199254740991

provider?string

Optional provider slug to filter by (e.g. openai, anthropic, aws-bedrock).

`application/json`

curl -X GET "https://api.eurouter.ai/api/v1/byok"

{
  "data": [
    {
      "allowed_api_key_hashes": [
        "string"
      ],
      "allowed_models": [
        "string"
      ],
      "always_use": true,
      "created_at": "string",
      "disabled": true,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "is_fallback": true,
      "label": "string",
      "last_used": "string",
      "name": "string",
      "provider": "string",
      "sort_order": -9007199254740991
    }
  ],
  "total_count": -9007199254740991
}

Create a BYOK provider credential

Authorization

bearerAuth

AuthorizationBearer <token>

API key in format: eur_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

allowed_api_key_hashes?array<>|

Optional allowlist of EUrouter API key hashes (api_keys.hash) that may use this credential. null means no restriction.

allowed_models?array<>|

Optional allowlist of model slugs this credential may be used for. null means no restriction.

always_use?boolean

Always use this credential for its provider, without falling back to EUrouter shared endpoints.

disabled?boolean

Whether this credential is disabled.

is_fallback?boolean

Whether this credential is treated as a fallback - used only after non-fallback keys for the same provider have been tried.

name?|

Optional human-readable name for the credential.

Length1 <= length <= 255

sort_order?integer

Position within the provider. Credentials are tried in ascending sort order.

Range0 <= value <= 9007199254740991

key*string

The raw provider credential (OpenRouter-compatible formats). Plain API key string for most providers. AWS Bedrock: a Bedrock API key string (region-locked to where it was issued) or an AWS credentials JSON {"accessKeyId","secretAccessKey"[,"sessionToken"]} for multi-region SigV4. Microsoft Foundry: {"api_key","resource_name"[,"resource_type":"ai_foundry"]}. EUrouter always calls the model's EU region/location for data residency, so any region field is ignored. Encrypted at rest and never returned in API responses.

Length1 <= length

provider*string

The upstream provider this credential authenticates against, as a lowercase slug (e.g. openai, anthropic, aws-bedrock).

Length1 <= length

Response Body

`application/json`

curl -X POST "https://api.eurouter.ai/api/v1/byok" \  -H "Content-Type: application/json" \  -d '{    "key": "string",    "provider": "string"  }'

{
  "data": {
    "allowed_api_key_hashes": [
      "string"
    ],
    "allowed_models": [
      "string"
    ],
    "always_use": true,
    "created_at": "string",
    "disabled": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_fallback": true,
    "label": "string",
    "last_used": "string",
    "name": "string",
    "provider": "string",
    "sort_order": -9007199254740991
  }
}

Test a BYOK provider credential before saving it

Authorization

bearerAuth

AuthorizationBearer <token>

API key in format: eur_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

key*string

The raw provider credential to test, in the same format the create endpoint accepts for this provider.

Length1 <= length

provider*string

The upstream provider slug to test against (e.g. openai, aws-bedrock, microsoft-foundry).

Length1 <= length

Response Body

`application/json`

curl -X POST "https://api.eurouter.ai/api/v1/byok/test" \  -H "Content-Type: application/json" \  -d '{    "key": "string",    "provider": "string"  }'

{
  "data": {
    "checks": [
      {
        "latency_ms": -9007199254740991,
        "message": "string",
        "ok": true,
        "target": "string"
      }
    ],
    "provider": "string",
    "success": true
  }
}

Get current BYOK subscription-period usage

Authorization

bearerAuth

AuthorizationBearer <token>

API key in format: eur_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Response Body

`application/json`

curl -X GET "https://api.eurouter.ai/api/v1/byok/usage"

{
  "data": {
    "period_start": "2019-08-24T14:15:22Z",
    "period_end": "2019-08-24T14:15:22Z",
    "successful_requests": 0,
    "settled_requests": 0,
    "pending_settlement_requests": 0,
    "free_request_allowance": 0,
    "allowance_used": 0,
    "allowance_remaining": 0,
    "chargeable_requests": 0,
    "estimated_upstream_cost_eur": "string",
    "eurouter_platform_fee_eur": "string",
    "eurouter_platform_fee_charged_eur": "string",
    "eurouter_platform_fee_pending_eur": "string",
    "platform_fee_rate": "string"
  }
}

Get BYOK provider credential

Authorization

bearerAuth

AuthorizationBearer <token>

API key in format: eur_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Path Parameters

id*string

The BYOK credential ID (UUID).

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

Response Body

`application/json`

curl -X GET "https://api.eurouter.ai/api/v1/byok/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "data": {
    "allowed_api_key_hashes": [
      "string"
    ],
    "allowed_models": [
      "string"
    ],
    "always_use": true,
    "created_at": "string",
    "disabled": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_fallback": true,
    "label": "string",
    "last_used": "string",
    "name": "string",
    "provider": "string",
    "sort_order": -9007199254740991
  }
}

Update BYOK provider credential

Authorization

bearerAuth

AuthorizationBearer <token>

API key in format: eur_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Path Parameters

id*string

The BYOK credential ID (UUID).

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

allowed_api_key_hashes?array<>|

Optional allowlist of EUrouter API key hashes (api_keys.hash) that may use this credential. null means no restriction.

allowed_models?array<>|

Optional allowlist of model slugs this credential may be used for. null means no restriction.

always_use?boolean

Always use this credential for its provider, without falling back to EUrouter shared endpoints.

disabled?boolean

Whether this credential is disabled.

is_fallback?boolean

Whether this credential is treated as a fallback - used only after non-fallback keys for the same provider have been tried.

name?|

Optional human-readable name for the credential.

Length1 <= length <= 255

sort_order?integer

Position within the provider. Credentials are tried in ascending sort order.

Range0 <= value <= 9007199254740991

key?string

A new raw provider credential to rotate in-place, in the same per-provider format the create endpoint accepts (plain key; AWS Bedrock key or credentials JSON; Microsoft Foundry {"api_key","resource_name"}). Any region field is ignored — EUrouter forces the model's EU region. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses.

Length1 <= length

Response Body

`application/json`

curl -X PATCH "https://api.eurouter.ai/api/v1/byok/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "allowed_api_key_hashes": [
      "string"
    ],
    "allowed_models": [
      "string"
    ],
    "always_use": true,
    "created_at": "string",
    "disabled": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_fallback": true,
    "label": "string",
    "last_used": "string",
    "name": "string",
    "provider": "string",
    "sort_order": -9007199254740991
  }
}

Delete BYOK provider credential

Authorization

bearerAuth

AuthorizationBearer <token>

API key in format: eur_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Path Parameters

id*string

The BYOK credential ID (UUID).

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://api.eurouter.ai/api/v1/byok/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "deleted": true
}

Test a stored BYOK provider credential

Authorization

bearerAuth

AuthorizationBearer <token>

API key in format: eur_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Path Parameters

id*string

The BYOK credential ID (UUID).

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

Response Body

`application/json`

curl -X POST "https://api.eurouter.ai/api/v1/byok/497f6eca-6276-4993-bfeb-53cbbbba6f08/test"

{
  "data": {
    "checks": [
      {
        "latency_ms": -9007199254740991,
        "message": "string",
        "ok": true,
        "target": "string"
      }
    ],
    "provider": "string",
    "success": true
  }
}

200application/json

201application/json

200application/json

200application/json

200application/json

200application/json

200application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`