GET
/
models
curl --request GET \
  --url https://app.happyrobot.ai/api/v1/models \
  --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>",
    "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.

Query Parameters

use_case_id
string

ID of the use case.

status
enum<string>

Status of the model.

Available options:
pending,
training,
active,
failed
trainable
string

Filter models that are trainable.

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.

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?

Create a new model and start trainingCreate a new hook