Kiln AI Server (0.1.0)

Download OpenAPI specification:

Learn more about Kiln AI at https://github.com/kiln-ai/kiln

Ping

Responses

Response samples

200

Content type

application/json

null

Create Project

Request Body schema: application/json
required

v	integer (V) Default: 1
	Id (string) or Id (null) (Id)
	Path (string) or Path (null) (Path)
created_at	string <date-time> (Created At)
created_by	string (Created By)
name required	string (Name) [ 1 .. 120 ] characters ^[A-Za-z0-9 _-]+$ A name for this entity.
	Description (string) or Description (null) (Description) A description of the project for you and your team. Will not be used in prompts/training/validation.

Responses

Request samples

Payload

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string"
}

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"model_type": "string"
}

Update Project

path Parameters

project_id

required

string (Project Id)

Request Body schema: application/json
required

object (Project Updates)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"model_type": "string"
}

Get Projects

Responses

Response samples

200

Content type

application/json

[{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"model_type": "string"
}
]

Get Project

path Parameters

project_id

required

string (Project Id)

Responses

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"model_type": "string"
}

Delete Project

path Parameters

project_id

required

string (Project Id)

Responses

Response samples

200
422

Content type

application/json

{ }

Import Project

query Parameters

project_path

required

string (Project Path)

Responses

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"model_type": "string"
}

Create Task

path Parameters

project_id

required

string (Project Id)

Request Body schema: application/json
required

object (Task Data)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"instruction": "string",
"requirements": [ ],
"output_json_schema": "string",
"input_json_schema": "string",
"thinking_instruction": "string",
"model_type": "string"
}

Update Task

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Request Body schema: application/json
required

object (Task Updates)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"instruction": "string",
"requirements": [ ],
"output_json_schema": "string",
"input_json_schema": "string",
"thinking_instruction": "string",
"model_type": "string"
}

Delete Task

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Responses

Response samples

200
422

Content type

application/json

null

Get Tasks

path Parameters

project_id

required

string (Project Id)

Responses

Response samples

200
422

Content type

application/json

[{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"instruction": "string",
"requirements": [ ],
"output_json_schema": "string",
"input_json_schema": "string",
"thinking_instruction": "string",
"model_type": "string"
}
]

Get Task

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Responses

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"name": "string",
"description": "string",
"instruction": "string",
"requirements": [ ],
"output_json_schema": "string",
"input_json_schema": "string",
"thinking_instruction": "string",
"model_type": "string"
}

Create Prompt

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Request Body schema: application/json
required

name required	string (Name)
	Description (string) or Description (null) (Description)
prompt required	string (Prompt)
	Chain Of Thought Instructions (string) or Chain Of Thought Instructions (null) (Chain Of Thought Instructions)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"prompt": "string",
"chain_of_thought_instructions": "string"
}

Response samples

200
422

Content type

application/json

{"name": "string",
"description": "string",
"generator_id": "string",
"prompt": "string",
"chain_of_thought_instructions": "string",
"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"model_type": "string"
}

Get Prompts

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Responses

Response samples

200
422

Content type

application/json

{"generators": [{"id": "string",
"short_description": "string",
"description": "string",
"name": "string",
"chain_of_thought": true
}
],
"prompts": [{"name": "string",
"description": "string",
"generator_id": "string",
"prompt": "string",
"chain_of_thought_instructions": "string",
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string"
}
]
}

Update Prompt

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)
prompt_id required	string (Prompt Id)

Request Body schema: application/json
required

name required	string (Name)
	Description (string) or Description (null) (Description)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200
422

Content type

application/json

{"name": "string",
"description": "string",
"generator_id": "string",
"prompt": "string",
"chain_of_thought_instructions": "string",
"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"model_type": "string"
}

Delete Prompt

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)
prompt_id required	string (Prompt Id)

Responses

Response samples

200
422

Content type

application/json

null

Get Run

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)
run_id required	string (Run Id)

Responses

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"input": "string",
"input_source": {"type": "human",
"properties": { }
},
"output": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"output": "string",
"source": {"type": "human",
"properties": { }
},
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"model_type": "string"
},
"repair_instructions": "string",
"repaired_output": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"output": "string",
"source": {"type": "human",
"properties": { }
},
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"model_type": "string"
},
"intermediate_outputs": {"property1": "string",
"property2": "string"
},
"tags": [ ],
"model_type": "string"
}

Delete Run

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)
run_id required	string (Run Id)

Responses

Response samples

200
422

Content type

application/json

null

Update Run

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)
run_id required	string (Run Id)

Request Body schema: application/json
required

object (Run Data)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"input": "string",
"input_source": {"type": "human",
"properties": { }
},
"output": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"output": "string",
"source": {"type": "human",
"properties": { }
},
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"model_type": "string"
},
"repair_instructions": "string",
"repaired_output": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"output": "string",
"source": {"type": "human",
"properties": { }
},
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"model_type": "string"
},
"intermediate_outputs": {"property1": "string",
"property2": "string"
},
"tags": [ ],
"model_type": "string"
}

Get Runs

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Responses

Response samples

200
422

Content type

application/json

[{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"input": "string",
"input_source": {"type": "human",
"properties": { }
},
"output": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"output": "string",
"source": {"type": "human",
"properties": { }
},
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"model_type": "string"
},
"repair_instructions": "string",
"repaired_output": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"output": "string",
"source": {"type": "human",
"properties": { }
},
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"model_type": "string"
},
"intermediate_outputs": {"property1": "string",
"property2": "string"
},
"tags": [ ],
"model_type": "string"
}
]

Get Runs Summary

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Responses

Response samples

200
422

Content type

application/json

[{"id": "string",
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"input_preview": "string",
"output_preview": "string",
"repair_state": "string",
"model_name": "string",
"input_source": "string",
"tags": ["string"
]
}
]

Delete Runs

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200
422

Content type

application/json

null

Run Task

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Request Body schema: application/json
required

model_name required	string (Model Name)
provider required	string (Provider)
	Plaintext Input (string) or Plaintext Input (null) (Plaintext Input)
	Structured Input (object) or Structured Input (null) (Structured Input)
	Ui Prompt Method (string) or Ui Prompt Method (null) (Ui Prompt Method)
	Array of Tags (strings) or Tags (null) (Tags)

Responses

Request samples

Payload

Content type

application/json

{"model_name": "string",
"provider": "string",
"plaintext_input": "string",
"structured_input": { },
"ui_prompt_method": "string",
"tags": ["string"
]
}

Response samples

200
422

Content type

application/json

{"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"input": "string",
"input_source": {"type": "human",
"properties": { }
},
"output": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"output": "string",
"source": {"type": "human",
"properties": { }
},
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"model_type": "string"
},
"repair_instructions": "string",
"repaired_output": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"output": "string",
"source": {"type": "human",
"properties": { }
},
"rating": {"v": 1,
"id": "string",
"path": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"type": "five_star",
"value": 0,
"requirement_ratings": { },
"model_type": "string"
},
"model_type": "string"
},
"intermediate_outputs": {"property1": "string",
"property2": "string"
},
"tags": [ ],
"model_type": "string"
}

Edit Tags

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Request Body schema: application/json
required

run_ids required	Array of strings (Run Ids)
	Array of Add Tags (strings) or Add Tags (null) (Add Tags)
	Array of Remove Tags (strings) or Remove Tags (null) (Remove Tags)

Responses

Request samples

Payload

Content type

application/json

{"run_ids": ["string"
],
"add_tags": ["string"
],
"remove_tags": ["string"
]
}

Response samples

200
422

Content type

application/json

null

Bulk Upload

path Parameters

project_id required	string (Project Id)
task_id required	string (Task Id)

Request Body schema: multipart/form-data
required

file

required

string <binary> (File)

Responses

Response samples

200
422

Content type

application/json

{"success": true,
"filename": "string",
"imported_count": 0
}

Kiln AI Server (0.1.0)

Ping

Responses

Response samples

Create Project

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update Project

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Projects

Responses

Response samples

Get Project

path Parameters

Responses

Response samples

Delete Project

path Parameters

Responses

Response samples

Import Project

query Parameters

Responses

Response samples

Create Task

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update Task

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Task

path Parameters

Responses

Response samples

Get Tasks

path Parameters

Responses

Response samples

Get Task

path Parameters

Responses

Response samples

Create Prompt

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Prompts

path Parameters

Responses

Response samples

Update Prompt

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Prompt

path Parameters

Responses

Response samples

Get Run

path Parameters

Responses

Response samples

Delete Run

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required