ModelService
Models

Enable a model

Changed on

Transitions a model to STATE_ENABLED, making it available for agent variations in the workspace

post/v1/workspaces/{workspaceId}/models/{id}:enable

Request

  • Base URL
    https://api.cadenya.com
  • URL
    https://api.cadenya.com/v1/workspaces/{workspaceId}/models/{id}:enable
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

idstring required
Example:model_01HXKD2E5NQM3T9AYWCFKJ4GED

Model ID

Request body

workspaceIdstring

Workspace ID.

idstring

Model ID

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "id": "model_01HXKD2E5NQM3T9AYWCFKJ4GED"
}

Response

OK

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

  • ac1a7f084068Revision changes
    • info

      added the optional property ///// to the response with the status

  • 3ecc1debabfaRevision changes
    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      the /////////////// response's property type changed from object to no type for status

    • breaking

      the /////////////// response's property type changed from object to no type for status

    • warning

      removed the optional property //////////////// from the response with the status

    • warning

      removed the optional property //////////////// from the response with the status

    • warning

      removed the optional property //////////////// from the response with the status

    • warning

      removed the optional property //////////////// from the response with the status

    • warning

      removed the optional property //////////////// from the response with the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      added discriminator to /////////////// response property for the response status

    • info

      added discriminator to /////////////// response property for the response status