Get a model (OpenAI-compatible)

GET

https://inference-api.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/openai/v1/models/{model}

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP

Path parameters

orgIdstringrequired
format: uuid
projectIdstringrequired
format: uuid
modelstringrequired

Returns

200

The model.

JSON

createdintegerrequired
The model's first release, in Unix seconds.
idstringrequired
The catalog ID.
objectstringrequired
owned_bystringrequired
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.

JSON

errorobjectrequired
4 properties
- codestringrequired
  The platform's error code, as in every other EZGH Cloud API.
  
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  What went wrong, for people. A validation failure's problems are appended to it.
- paramstring | nullrequired
  The request field at fault (input, input[3], dimensions), or null.
- typestringrequired
  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.

JSON

errorobjectrequired
4 properties
- codestringrequired
  The platform's error code, as in every other EZGH Cloud API.
  
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  What went wrong, for people. A validation failure's problems are appended to it.
- paramstring | nullrequired
  The request field at fault (input, input[3], dimensions), or null.
- typestringrequired
  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.

JSON

errorobjectrequired
4 properties
- codestringrequired
  The platform's error code, as in every other EZGH Cloud API.
  
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  What went wrong, for people. A validation failure's problems are appended to it.
- paramstring | nullrequired
  The request field at fault (input, input[3], dimensions), or null.
- typestringrequired
  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.

JSON

errorobjectrequired
4 properties
- codestringrequired
  The platform's error code, as in every other EZGH Cloud API.
  
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  What went wrong, for people. A validation failure's problems are appended to it.
- paramstring | nullrequired
  The request field at fault (input, input[3], dimensions), or null.
- typestringrequired
  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).

JSON

errorobjectrequired
4 properties
- codestringrequired
  The platform's error code, as in every other EZGH Cloud API.
  
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  What went wrong, for people. A validation failure's problems are appended to it.
- paramstring | nullrequired
  The request field at fault (input, input[3], dimensions), or null.
- typestringrequired
  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.

JSON

errorobjectrequired
4 properties
- codestringrequired
  The platform's error code, as in every other EZGH Cloud API.
  
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  What went wrong, for people. A validation failure's problems are appended to it.
- paramstring | nullrequired
  The request field at fault (input, input[3], dimensions), or null.
- typestringrequired
  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.

JSON

errorobjectrequired
4 properties
- codestringrequired
  The platform's error code, as in every other EZGH Cloud API.
  
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  What went wrong, for people. A validation failure's problems are appended to it.
- paramstring | nullrequired
  The request field at fault (input, input[3], dimensions), or null.
- typestringrequired
  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.

JSON

errorobjectrequired
4 properties
- codestringrequired
  The platform's error code, as in every other EZGH Cloud API.
  
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  What went wrong, for people. A validation failure's problems are appended to it.
- paramstring | nullrequired
  The request field at fault (input, input[3], dimensions), or null.
- typestringrequired
  invalid_request_error, authentication_error, permission_error, not_found_error, rate_limit_error, insufficient_quota or api_error. Treat it as an open string.