GET
/
models
/
{id}
curl --request GET \
  --url https://app.happyrobot.ai/api/v1/models/{id} \
  --header 'authorization: <authorization>'
{
  "id": "<string>",
  "organization_id": "<string>",
  "use_case_id": "<string>",
  "created_at": "2024-01-01T01:01:01Z",
  "status": "pending",
  "provider": "<string>",
  "name": "<string>",
  "description": "<string>",
  "train_sample_ids": [
    "<string>"
  ],
  "test_sample_ids": [
    "<string>"
  ],
  "from_model_id": "<string>",
  "explain_tools": true,
  "trainable": true,
  "compressed": true,
  "compressed_version": "<string>"
}

Headers

authorization
string
required

Your API key for authentication. Use Bearer format.

Path Parameters

id
string
required

ID of the model.

Response

200 - application/json
id
string
required

ID of the model.

organization_id
string | null

ID of the organization.

use_case_id
string | null

ID of the use case.

created_at
string
required

Creation date of the model.

status
enum<string>
required

Status of the model.

Available options:
pending,
training,
active,
failed
provider
string
required
name
string
required

Name of the model.

description
string

Description of the model.

train_sample_ids
string[]

IDs of the training samples.

test_sample_ids
string[]

IDs of the testing samples.

from_model_id
string

ID of the model to clone.

explain_tools
boolean
default: true

Enable explain tools.

trainable
boolean
default: false

Whether the model is trainable.

compressed
boolean
default: false
compressed_version
string
default: v0

Was this page helpful?

Returns a list of voicesCreate a new model and start training