---
title: "Add an AI provider, or find the one already added, by external identifier"
description: "The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile.\n\n### Quire permissions\n\nRequired capability: `ai/configure`.\n\nCredential scopes: `integrations:write`.\n\nThe acting subject must also be allowed to perform this action in the organisation."
image: "https://docs.quirelms.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Quire API › integrations

`PUT /ai_providers/ext:{external_id}`

The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile.

\### Quire permissions

Required capability: `ai/configure`.

Credential scopes: `integrations:write`.

The acting subject must also be allowed to perform this action in the organisation.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`, scopes: `integrations:write`
- `oauth2`, oauth2, scopes: `integrations:write`

## Path parameters

- `upsertAiProvider.path.external_id` (string, required) — The external identifier, unique per tenant per type, as supplied by the system of record.

## Header parameters

- `upsertAiProvider.header.Quire-Version` (string, optional) — The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.
  - format `date`
- `upsertAiProvider.header.Idempotency-Key` (string, optional) — A caller-chosen key making this request safe to retry. A replay of a completed request returns the recorded response with `Idempotency-Replayed: true`. Reusing a key for a different request is refused.
  - maxLength 255

## Request body

_Required._

- `upsertAiProvider.provider` (string, required)
  - one of `"openai"`, `"azure_openai"`, `"anthropic"`, `"gemini"`, `"bedrock"`, `"deepseek"`, `"ollama"`, `"openai_compatible"`, `"in_process"`
- `upsertAiProvider.label` (string, required)
  - minLength 1; maxLength 120
- `upsertAiProvider.region` (string, required) — Must be the organisation's data region.
  - minLength 2; maxLength 20
- `upsertAiProvider.training_opt_out` (string, required)
  - one of `"local"`, `"contractual"`, `"configured"`, `"unverified"`
- `upsertAiProvider.endpoint` (any of, optional) — Absent for a hosted vendor with a fixed address and for the built-in demonstration model.
  - any of: `string`, `null`
- `upsertAiProvider.credential` (any of, optional) — The provider API key. Write-only: it is sealed on receipt and never returned, logged or shown again.
  - any of: `string`, `null`
- `upsertAiProvider.models` (array<string>, optional)
  - minLength 1; maxLength 200
- `upsertAiProvider.agreement_reference` (any of, optional)
  - any of: `string`, `null`
- `upsertAiProvider.acknowledge_unverified` (boolean, optional)

## Example request

```json
{
  "provider": "openai",
  "label": "string",
  "endpoint": "string",
  "region": "string",
  "credential": "string",
  "models": [
    "string"
  ],
  "training_opt_out": "local",
  "agreement_reference": "string",
  "acknowledge_unverified": true
}
```

## Code samples

### cURL

```curl
curl --request PUT \
  --url https://your-organisation.quirelms.com/api/v1/ai_providers/ext:string \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "openai",
  "label": "string",
  "endpoint": "string",
  "region": "string",
  "credential": "string",
  "models": [
    "string"
  ],
  "training_opt_out": "local",
  "agreement_reference": "string",
  "acknowledge_unverified": true
}
'
```

### TypeScript

```typescript
const url = 'https://your-organisation.quirelms.com/api/v1/ai_providers/ext:string';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    provider: 'openai',
    label: 'string',
    endpoint: 'string',
    region: 'string',
    credential: 'string',
    models: ['string'],
    training_opt_out: 'local',
    agreement_reference: 'string',
    acknowledge_unverified: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://your-organisation.quirelms.com/api/v1/ai_providers/ext:string"

payload = {
    "provider": "openai",
    "label": "string",
    "endpoint": "string",
    "region": "string",
    "credential": "string",
    "models": ["string"],
    "training_opt_out": "local",
    "agreement_reference": "string",
    "acknowledge_unverified": True
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Success.

#### Example

```json
{
  "id": "string",
  "external_id": "string",
  "provider": "string",
  "label": "string",
  "region": "string",
  "key_origin": "string",
  "training_opt_out": "string",
  "allowed_models": [
    "string"
  ],
  "capabilities_snapshot": null,
  "status": "string",
  "acknowledged_at": "string",
  "validated_at": "string",
  "created_at": "string",
  "updated_at": "string"
}
```

- `upsertAiProvider.response.200.id` (string, required)
- `upsertAiProvider.response.200.external_id` (string | null, required)
- `upsertAiProvider.response.200.provider` (string, required)
- `upsertAiProvider.response.200.label` (string, required)
- `upsertAiProvider.response.200.region` (string, required)
- `upsertAiProvider.response.200.key_origin` (string, required)
- `upsertAiProvider.response.200.training_opt_out` (string, required)
- `upsertAiProvider.response.200.allowed_models` (array<string>, required)
- `upsertAiProvider.response.200.capabilities_snapshot` (unknown, required)
- `upsertAiProvider.response.200.status` (string, required)
- `upsertAiProvider.response.200.acknowledged_at` (any of, required)
  - any of: `string`, `null`
- `upsertAiProvider.response.200.validated_at` (any of, required)
  - any of: `string`, `null`
- `upsertAiProvider.response.200.created_at` (string, required) — RFC 3339 timestamp in UTC.
- `upsertAiProvider.response.200.updated_at` (string, required) — RFC 3339 timestamp in UTC.

### 201

Success.

#### Example

```json
{
  "id": "string",
  "external_id": "string",
  "provider": "string",
  "label": "string",
  "region": "string",
  "key_origin": "string",
  "training_opt_out": "string",
  "allowed_models": [
    "string"
  ],
  "capabilities_snapshot": null,
  "status": "string",
  "acknowledged_at": "string",
  "validated_at": "string",
  "created_at": "string",
  "updated_at": "string"
}
```

- `upsertAiProvider.response.201.id` (string, required)
- `upsertAiProvider.response.201.external_id` (string | null, required)
- `upsertAiProvider.response.201.provider` (string, required)
- `upsertAiProvider.response.201.label` (string, required)
- `upsertAiProvider.response.201.region` (string, required)
- `upsertAiProvider.response.201.key_origin` (string, required)
- `upsertAiProvider.response.201.training_opt_out` (string, required)
- `upsertAiProvider.response.201.allowed_models` (array<string>, required)
- `upsertAiProvider.response.201.capabilities_snapshot` (unknown, required)
- `upsertAiProvider.response.201.status` (string, required)
- `upsertAiProvider.response.201.acknowledged_at` (any of, required)
  - any of: `string`, `null`
- `upsertAiProvider.response.201.validated_at` (any of, required)
  - any of: `string`, `null`
- `upsertAiProvider.response.201.created_at` (string, required) — RFC 3339 timestamp in UTC.
- `upsertAiProvider.response.201.updated_at` (string, required) — RFC 3339 timestamp in UTC.

### 401

The credential is missing, malformed, expired or revoked.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `upsertAiProvider.response.401.type` (string, required)
  - format `uri`
- `upsertAiProvider.response.401.title` (string, required)
- `upsertAiProvider.response.401.status` (integer, required)
- `upsertAiProvider.response.401.code` (string, required)
- `upsertAiProvider.response.401.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `upsertAiProvider.response.401.detail` (string, required)
- `upsertAiProvider.response.401.request_id` (string, required)
- `upsertAiProvider.response.401.docs_url` (string, required)
  - format `uri`
- `upsertAiProvider.response.401.errors` (array<object>, optional)
  - `upsertAiProvider.response.401.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `upsertAiProvider.response.401.errors.code` (string, required)
  - `upsertAiProvider.response.401.errors.detail` (string, required)
- `upsertAiProvider.response.401.retry_after` (integer | null, optional)

### 403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `upsertAiProvider.response.403.type` (string, required)
  - format `uri`
- `upsertAiProvider.response.403.title` (string, required)
- `upsertAiProvider.response.403.status` (integer, required)
- `upsertAiProvider.response.403.code` (string, required)
- `upsertAiProvider.response.403.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `upsertAiProvider.response.403.detail` (string, required)
- `upsertAiProvider.response.403.request_id` (string, required)
- `upsertAiProvider.response.403.docs_url` (string, required)
  - format `uri`
- `upsertAiProvider.response.403.errors` (array<object>, optional)
  - `upsertAiProvider.response.403.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `upsertAiProvider.response.403.errors.code` (string, required)
  - `upsertAiProvider.response.403.errors.detail` (string, required)
- `upsertAiProvider.response.403.retry_after` (integer | null, optional)

### 404

No such resource, or none this credential is permitted to know about.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `upsertAiProvider.response.404.type` (string, required)
  - format `uri`
- `upsertAiProvider.response.404.title` (string, required)
- `upsertAiProvider.response.404.status` (integer, required)
- `upsertAiProvider.response.404.code` (string, required)
- `upsertAiProvider.response.404.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `upsertAiProvider.response.404.detail` (string, required)
- `upsertAiProvider.response.404.request_id` (string, required)
- `upsertAiProvider.response.404.docs_url` (string, required)
  - format `uri`
- `upsertAiProvider.response.404.errors` (array<object>, optional)
  - `upsertAiProvider.response.404.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `upsertAiProvider.response.404.errors.code` (string, required)
  - `upsertAiProvider.response.404.errors.detail` (string, required)
- `upsertAiProvider.response.404.retry_after` (integer | null, optional)

### 409

The request conflicts with the current state, with a previous use of the same idempotency key, or with a concurrent write.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `upsertAiProvider.response.409.type` (string, required)
  - format `uri`
- `upsertAiProvider.response.409.title` (string, required)
- `upsertAiProvider.response.409.status` (integer, required)
- `upsertAiProvider.response.409.code` (string, required)
- `upsertAiProvider.response.409.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `upsertAiProvider.response.409.detail` (string, required)
- `upsertAiProvider.response.409.request_id` (string, required)
- `upsertAiProvider.response.409.docs_url` (string, required)
  - format `uri`
- `upsertAiProvider.response.409.errors` (array<object>, optional)
  - `upsertAiProvider.response.409.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `upsertAiProvider.response.409.errors.code` (string, required)
  - `upsertAiProvider.response.409.errors.detail` (string, required)
- `upsertAiProvider.response.409.retry_after` (integer | null, optional)

### 422

The request was understood and its content is not valid. `errors` names each field.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `upsertAiProvider.response.422.type` (string, required)
  - format `uri`
- `upsertAiProvider.response.422.title` (string, required)
- `upsertAiProvider.response.422.status` (integer, required)
- `upsertAiProvider.response.422.code` (string, required)
- `upsertAiProvider.response.422.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `upsertAiProvider.response.422.detail` (string, required)
- `upsertAiProvider.response.422.request_id` (string, required)
- `upsertAiProvider.response.422.docs_url` (string, required)
  - format `uri`
- `upsertAiProvider.response.422.errors` (array<object>, optional)
  - `upsertAiProvider.response.422.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `upsertAiProvider.response.422.errors.code` (string, required)
  - `upsertAiProvider.response.422.errors.detail` (string, required)
- `upsertAiProvider.response.422.retry_after` (integer | null, optional)

### 429

A rate limit or a concurrency cap was reached. `Retry-After` says when to try again.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `upsertAiProvider.response.429.type` (string, required)
  - format `uri`
- `upsertAiProvider.response.429.title` (string, required)
- `upsertAiProvider.response.429.status` (integer, required)
- `upsertAiProvider.response.429.code` (string, required)
- `upsertAiProvider.response.429.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `upsertAiProvider.response.429.detail` (string, required)
- `upsertAiProvider.response.429.request_id` (string, required)
- `upsertAiProvider.response.429.docs_url` (string, required)
  - format `uri`
- `upsertAiProvider.response.429.errors` (array<object>, optional)
  - `upsertAiProvider.response.429.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `upsertAiProvider.response.429.errors.code` (string, required)
  - `upsertAiProvider.response.429.errors.detail` (string, required)
- `upsertAiProvider.response.429.retry_after` (integer | null, optional)

### 500

Something failed at our end. Quote `request_id` when reporting it.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `upsertAiProvider.response.500.type` (string, required)
  - format `uri`
- `upsertAiProvider.response.500.title` (string, required)
- `upsertAiProvider.response.500.status` (integer, required)
- `upsertAiProvider.response.500.code` (string, required)
- `upsertAiProvider.response.500.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `upsertAiProvider.response.500.detail` (string, required)
- `upsertAiProvider.response.500.request_id` (string, required)
- `upsertAiProvider.response.500.docs_url` (string, required)
  - format `uri`
- `upsertAiProvider.response.500.errors` (array<object>, optional)
  - `upsertAiProvider.response.500.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `upsertAiProvider.response.500.errors.code` (string, required)
  - `upsertAiProvider.response.500.errors.detail` (string, required)
- `upsertAiProvider.response.500.retry_after` (integer | null, optional)


Source: https://docs.quirelms.com/api/integrations/upsertAiProvider/index.md