---
title: "Get a model (OpenAI-compatible)"
---

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

Path: Inference API

`GET /v1/organizations/{orgId}/projects/{projectId}/openai/v1/models/{model}`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`

## Path parameters

- `GetModel.path.orgId` (string, required)
  - format `uuid`
- `GetModel.path.projectId` (string, required)
  - format `uuid`
- `GetModel.path.model` (string, required)

## Code samples

### cURL

```curl
curl --request GET \
  --url https://inference-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/openai/v1/models/string \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://inference-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/openai/v1/models/string';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

### Python

```python
import requests

url = "https://inference-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/openai/v1/models/string"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The model.

#### Example

```json
{
  "created": 0,
  "id": "qwen3-embedding-0.6b",
  "object": "model",
  "owned_by": "Qwen"
}
```

- `GetModel.response.200.created` (integer, required) — The model's first release, in Unix seconds.
- `GetModel.response.200.id` (string, required) — The catalog ID.
- `GetModel.response.200.object` (string, required)
- `GetModel.response.200.owned_by` (string, required) — The model's publisher.

### 400

invalid_request_error (invalid_request, or the product's own code): the request isn't valid; param names the field.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}
```

- `GetModel.response.400.error` (object, required)
  - `GetModel.response.400.error.code` (string, required) — The platform's error code, as in every other EZGH Cloud API.
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetModel.response.400.error.message` (string, required) — What went wrong, for people. A validation failure's problems are appended to it.
  - `GetModel.response.400.error.param` (string | null, required) — The request field at fault (input, input[3], dimensions), or null.
  - `GetModel.response.400.error.type` (string, required) — invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.

### 401

authentication_error (unauthenticated): no bearer credential, or one that doesn't check out. The session cookie isn't read.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}
```

- `GetModel.response.401.error` (object, required)
  - `GetModel.response.401.error.code` (string, required) — The platform's error code, as in every other EZGH Cloud API.
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetModel.response.401.error.message` (string, required) — What went wrong, for people. A validation failure's problems are appended to it.
  - `GetModel.response.401.error.param` (string | null, required) — The request field at fault (input, input[3], dimensions), or null.
  - `GetModel.response.401.error.type` (string, required) — invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.

### 403

permission_error (access_denied): the caller's policies don't allow the action.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}
```

- `GetModel.response.403.error` (object, required)
  - `GetModel.response.403.error.code` (string, required) — The platform's error code, as in every other EZGH Cloud API.
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetModel.response.403.error.message` (string, required) — What went wrong, for people. A validation failure's problems are appended to it.
  - `GetModel.response.403.error.param` (string | null, required) — The request field at fault (input, input[3], dimensions), or null.
  - `GetModel.response.403.error.type` (string, required) — invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.

### 404

not_found_error (not_found, or the product's own code): unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}
```

- `GetModel.response.404.error` (object, required)
  - `GetModel.response.404.error.code` (string, required) — The platform's error code, as in every other EZGH Cloud API.
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetModel.response.404.error.message` (string, required) — What went wrong, for people. A validation failure's problems are appended to it.
  - `GetModel.response.404.error.param` (string | null, required) — The request field at fault (input, input[3], dimensions), or null.
  - `GetModel.response.404.error.type` (string, required) — invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.

### 410

The pinned model version is retired (model_retired, param model).

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}
```

- `GetModel.response.410.error` (object, required)
  - `GetModel.response.410.error.code` (string, required) — The platform's error code, as in every other EZGH Cloud API.
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetModel.response.410.error.message` (string, required) — What went wrong, for people. A validation failure's problems are appended to it.
  - `GetModel.response.410.error.param` (string | null, required) — The request field at fault (input, input[3], dimensions), or null.
  - `GetModel.response.410.error.type` (string, required) — invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.

### 429

rate_limit_error (too_many_requests), with Retry-After; or insufficient_quota (insufficient_quota), a monthly limit, without one and with x-should-retry: false.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}
```

- `GetModel.response.429.error` (object, required)
  - `GetModel.response.429.error.code` (string, required) — The platform's error code, as in every other EZGH Cloud API.
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetModel.response.429.error.message` (string, required) — What went wrong, for people. A validation failure's problems are appended to it.
  - `GetModel.response.429.error.param` (string | null, required) — The request field at fault (input, input[3], dimensions), or null.
  - `GetModel.response.429.error.type` (string, required) — invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.

### 500

api_error (internal_error): a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}
```

- `GetModel.response.500.error` (object, required)
  - `GetModel.response.500.error.code` (string, required) — The platform's error code, as in every other EZGH Cloud API.
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetModel.response.500.error.message` (string, required) — What went wrong, for people. A validation failure's problems are appended to it.
  - `GetModel.response.500.error.param` (string | null, required) — The request field at fault (input, input[3], dimensions), or null.
  - `GetModel.response.500.error.type` (string, required) — invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.

### 503

api_error (unavailable): a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}
```

- `GetModel.response.503.error` (object, required)
  - `GetModel.response.503.error.code` (string, required) — The platform's error code, as in every other EZGH Cloud API.
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetModel.response.503.error.message` (string, required) — What went wrong, for people. A validation failure's problems are appended to it.
  - `GetModel.response.503.error.param` (string | null, required) — The request field at fault (input, input[3], dimensions), or null.
  - `GetModel.response.503.error.type` (string, required) — invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.


Source: https://docs.ezghcloud.com/inference-api/GetModel/index.md