# Create a virtual agent profile and return its synthetic id

Operation ID: `connectors.openaiCreateAssistant`

Create a virtual agent profile and return its synthetic id. ``tool_types`` and ``vector_store_ids`` are kept for API parity and are unused in V2 (the RAG flow uses vector stores elsewhere).

## Public method

`createAssistant`

Signature: `connectors.openai.createClient(config).createAssistant(body)`

Return type: `Promise<OpenAICreateAssistantResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/openai/create-assistant`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`OpenAICreateAssistantRequest`](../models/OpenAICreateAssistantRequest.md) | Yes |  |  |  | No |  |

Request model: [`OpenAICreateAssistantRequest`](../models/OpenAICreateAssistantRequest.md)

## Request example

```json
{
  "api_key": "example-api-key",
  "default_model": "gpt-4o",
  "description": "example-description",
  "environment": "example-environment",
  "instructions": "example-instructions",
  "mode": "sandbox",
  "model": "example-model",
  "name": "Example Name",
  "organization": "example-organization"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`OpenAICreateAssistantResponse`](../models/OpenAICreateAssistantResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
"example-create-assistant"
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { OpenAICreateAssistantRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_key": "example-api-key",
  "default_model": "gpt-4o",
  "description": "example-description",
  "environment": "example-environment",
  "instructions": "example-instructions",
  "mode": "sandbox",
  "model": "example-model",
  "name": "Example Name",
  "organization": "example-organization"
};

const result = await connectors.openai.createClient(config).createAssistant(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"example-api-key","default_model":"gpt-4o","description":"example-description","environment":"example-environment","instructions":"example-instructions","mode":"sandbox","model":"example-model","name":"Example Name","organization":"example-organization"}' \
  'https://dev-api-connectors.health.cloud/connectors/openai/create-assistant'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.