Tasks
Create a task
POST
/
tasks
Authorization
Body
curl --request POST \
--url https://api.honeyhive.ai/tasks \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"created_at": "2023-11-07T05:31:56Z",
"datasets": [
{
"bytes": 123,
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"file": [],
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"purpose": "<string>",
"task": "<string>",
"tenant": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"fine_tuned_models": [
{
"created_at": "2023-11-07T05:31:56Z",
"fine_tuned_model": "<string>",
"hyperparams": "<string>",
"id": "<string>",
"model": "<string>",
"object": "<string>",
"org_id": "<string>",
"result_files": "<string>",
"status": "<string>",
"training_files": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"validation_files": "<string>"
}
],
"metrics": [
{
"code_snippet": "<string>",
"criteria": "<string>",
"description": "<string>",
"enabled_in_prod": true,
"id": "<string>",
"name": "<string>",
"needs_ground_truth": true,
"pass_when": true,
"prompt": "<string>",
"return_type": "<string>",
"task": "<string>",
"threshold": {},
"updated_at": "2023-11-07T05:31:56Z"
}
],
"name": "<string>",
"prompts": [
{
"created_at": "2023-11-07T05:31:56Z",
"few_shot_examples": [],
"hyperparameters": {},
"input_variables": [],
"is_deployed": true,
"model": "<string>",
"name": "<string>",
"task": "<string>",
"text": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": "<string>"
}
],
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}'
{
"created_at": "2023-11-07T05:31:56Z",
"datasets": [
{
"bytes": 123,
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"file": [],
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"purpose": "<string>",
"task": "<string>",
"tenant": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"fine_tuned_models": [
{
"created_at": "2023-11-07T05:31:56Z",
"fine_tuned_model": "<string>",
"hyperparams": "<string>",
"id": "<string>",
"model": "<string>",
"object": "<string>",
"org_id": "<string>",
"result_files": "<string>",
"status": "<string>",
"training_files": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"validation_files": "<string>"
}
],
"id": "<string>",
"metrics": [
{
"code_snippet": "<string>",
"criteria": "<string>",
"description": "<string>",
"enabled_in_prod": true,
"id": "<string>",
"name": "<string>",
"needs_ground_truth": true,
"pass_when": true,
"prompt": "<string>",
"return_type": "<string>",
"task": "<string>",
"threshold": {},
"updated_at": "2023-11-07T05:31:56Z"
}
],
"name": "<string>",
"prompts": [
{
"created_at": "2023-11-07T05:31:56Z",
"few_shot_examples": [],
"hyperparameters": {},
"input_variables": [],
"is_deployed": true,
"model": "<string>",
"name": "<string>",
"task": "<string>",
"text": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": "<string>"
}
],
"tenant": "<string>",
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
created_at
string
The timestamp of when the task was created
datasets
object[]
The datasets for the task
description
string
The description of the task
fine_tuned_models
object[]
The fine-tuned models for the task
metrics
object[]
The metrics for the task
name
string
The name of the task
prompts
object[]
The prompts for the task
type
string
The type of the task
updated_at
string
The timestamp of when the task was last updated
Response
200 - application/json
created_at
string
The timestamp of when the task was created
datasets
object[]
The datasets for the task
description
string | null
The description of the task
fine_tuned_models
object[]
The fine-tuned models for the task
id
string
The ID of the task
metrics
object[]
The metrics for the task
name
string
The name of the task
prompts
object[]
The prompts for the task
tenant
string
The tenant that this task belongs to
type
string | null
The type of the task
updated_at
string
The timestamp of when the task was last updated
curl --request POST \
--url https://api.honeyhive.ai/tasks \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"created_at": "2023-11-07T05:31:56Z",
"datasets": [
{
"bytes": 123,
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"file": [],
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"purpose": "<string>",
"task": "<string>",
"tenant": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"fine_tuned_models": [
{
"created_at": "2023-11-07T05:31:56Z",
"fine_tuned_model": "<string>",
"hyperparams": "<string>",
"id": "<string>",
"model": "<string>",
"object": "<string>",
"org_id": "<string>",
"result_files": "<string>",
"status": "<string>",
"training_files": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"validation_files": "<string>"
}
],
"metrics": [
{
"code_snippet": "<string>",
"criteria": "<string>",
"description": "<string>",
"enabled_in_prod": true,
"id": "<string>",
"name": "<string>",
"needs_ground_truth": true,
"pass_when": true,
"prompt": "<string>",
"return_type": "<string>",
"task": "<string>",
"threshold": {},
"updated_at": "2023-11-07T05:31:56Z"
}
],
"name": "<string>",
"prompts": [
{
"created_at": "2023-11-07T05:31:56Z",
"few_shot_examples": [],
"hyperparameters": {},
"input_variables": [],
"is_deployed": true,
"model": "<string>",
"name": "<string>",
"task": "<string>",
"text": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": "<string>"
}
],
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}'
{
"created_at": "2023-11-07T05:31:56Z",
"datasets": [
{
"bytes": 123,
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"file": [],
"id": "<string>",
"name": "<string>",
"prompt": "<string>",
"purpose": "<string>",
"task": "<string>",
"tenant": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"fine_tuned_models": [
{
"created_at": "2023-11-07T05:31:56Z",
"fine_tuned_model": "<string>",
"hyperparams": "<string>",
"id": "<string>",
"model": "<string>",
"object": "<string>",
"org_id": "<string>",
"result_files": "<string>",
"status": "<string>",
"training_files": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"validation_files": "<string>"
}
],
"id": "<string>",
"metrics": [
{
"code_snippet": "<string>",
"criteria": "<string>",
"description": "<string>",
"enabled_in_prod": true,
"id": "<string>",
"name": "<string>",
"needs_ground_truth": true,
"pass_when": true,
"prompt": "<string>",
"return_type": "<string>",
"task": "<string>",
"threshold": {},
"updated_at": "2023-11-07T05:31:56Z"
}
],
"name": "<string>",
"prompts": [
{
"created_at": "2023-11-07T05:31:56Z",
"few_shot_examples": [],
"hyperparameters": {},
"input_variables": [],
"is_deployed": true,
"model": "<string>",
"name": "<string>",
"task": "<string>",
"text": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version": "<string>"
}
],
"tenant": "<string>",
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}