Models
Returns a list of models
Calls
- GETGet Calls
- GETGet Call
- GETGet Transcript
- GETGet current page
- GETList Call tags
- GETReturn a pre-signed URL to the call recording
- GETReturn the logs for a call
- GETGet the usage for the given organization
- POSTStop Call
- POSTCancel Call
- POSTAdd a note to a call
- POSTTrigger async export of calls CSV to requester email
- PATCHUpdate a note on a call
- PATCHSet call as viewed by the user making the request
- PATCHSet call rating
- DELDelete a note from a call
- DELDelete a call
Dial
Orgs
Numbers
Usecases
Agents
Models
Returns a list of models
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",
"name": "<string>",
"description": "<string>",
"from_model_id": "<string>",
"trainable": false,
"use_backup_for_generations": false,
"use_backup_when_idle": false
}
]
Headers
Your API key for authentication. Use Bearer format.
Example:
"Bearer API_KEY"
Query Parameters
ID of the use case.
Status of the model.
Available options:
pending
, training
, active
, failed
Example:
"active"
Filter models that are trainable.
Example:
"true"
Response
200
application/json
200
The response is of type object[]
.
Was this page helpful?
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",
"name": "<string>",
"description": "<string>",
"from_model_id": "<string>",
"trainable": false,
"use_backup_for_generations": false,
"use_backup_when_idle": false
}
]