Get a model by ID

Retrieves a model by ID from the workspace

get/v1/workspaces/{workspaceId}/models/{id}

Path parameters

workspaceIdstring required

Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

idstring required

Example:model_01HXKD2E5NQM3T9AYWCFKJ4GED

Model ID

Response

state'STATE_UNSPECIFIED' | 'STATE_ENABLED' | 'STATE_DISABLED' enum required

Whether the model is usable in this workspace. Output only. Use the :enable and :disable actions to transition.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "aiProviderKey": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}

Changes

Changed in 8 of the 57 revisions of this API.41517

Aug 5, 2026ac1a7f0840681See the full diff
- ○
  added the optional property spec/allOf[ModelSpec]/reasoning to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 19, 20263ecc1debabfa454See the full diff
- ▲
  added AIProviderConfig_Openrouter AIProviderConfig_Openai AIProviderConfig_OpenaiCompatible to the info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/config/allOf[AIProviderConfig]/ response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  added AIProviderCredential_ApiKey AIProviderCredential_Headers to the info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/credentials/allOf[AIProviderCredential]/ response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  the info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/config/allOf[AIProviderConfig]/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/credentials/allOf[AIProviderCredential]/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ●
  removed the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/config/allOf[AIProviderConfig]/openai from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/config/allOf[AIProviderConfig]/openaiCompatible from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/config/allOf[AIProviderConfig]/openrouter from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/credentials/allOf[AIProviderCredential]/apiKey from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/credentials/allOf[AIProviderCredential]/headers from the response with the 200 status
  response-optional-property-removed
- ○
  the response property spec/allOf[ModelSpec]/family became required for the status 200
  response-property-became-required
- ○
  the response property spec/allOf[ModelSpec]/provider became required for the status 200
  response-property-became-required
- ○
  added discriminator to info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/config/allOf[AIProviderConfig]/ response property for the response status 200
  response-property-discriminator-added
- ○
  added discriminator to info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/credentials/allOf[AIProviderCredential]/ response property for the response status 200
  response-property-discriminator-added
Jul 2, 202606e0e37c149982See the full diff
- ●
  removed the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/metadata/bundleKey from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/apiKey from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/openrouter from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property metadata/allOf[ResourceMetadata]/bundleKey from the response with the 200 status
  response-optional-property-removed
- ●
  added the new AI_PROVIDER_ANTHROPIC enum value to the info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new AI_PROVIDER_GEMINI enum value to the info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new AI_PROVIDER_OPENAI enum value to the info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new AI_PROVIDER_OPENAI_COMPATIBLE enum value to the info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/provider response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/config to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[AIProviderKey]/spec/credentials to the response with the 200 status
  response-optional-property-added
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 12, 2026ea07a25ab5da13See the full diff
- ●
  removed the optional property info/allOf[ModelInfo]/provider from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property info/allOf[ModelInfo]/lastUsedAt to the response with the 200 status
  response-optional-property-added
- ○
  added AIProviderKey to the info/allOf[ModelInfo]/aiProviderKey response property allOf list for the response status 200
  response-property-all-of-added
- ○
  removed ResourceMetadata from the info/allOf[ModelInfo]/aiProviderKey response property allOf list for the response status 200
  response-property-all-of-removed
Jun 9, 202613d98d37dd9613See the full diff
- ●
  removed the optional property spec/allOf[ModelSpec]/status from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property info/allOf[ModelInfo]/aiProviderKey/allOf[ResourceMetadata]/updatedAt to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property metadata/allOf[ResourceMetadata]/updatedAt to the response with the 200 status
  response-optional-property-added
- ○
  added the required property state to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 7, 2026efdacf70acce2See the full diff
- ○
  added ResourceMetadata to the info/allOf[ModelInfo]/aiProviderKey response property allOf list for the response status 200
  response-property-all-of-added
- ○
  removed BareMetadata from the info/allOf[ModelInfo]/aiProviderKey response property allOf list for the response status 200
  response-property-all-of-removed
Jun 7, 20262bd8fb53e6491See the full diff
- ○
  added the optional property info/allOf[ModelInfo]/agentVariationCount to the response with the 200 status
  response-optional-property-added
Jun 7, 2026873a704256d91See the full diff
- ○
  added the optional property info to the response with the 200 status
  response-optional-property-added

Full history