Kiln AI Server (0.1.0)

Download OpenAPI specification:Download

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

Ping

Responses

Response samples

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

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

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

Content type
application/json
{ }

Response samples

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

Content type
application/json
[
  • {
    }
]

Get Project

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

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

Content type
application/json
{ }

Import Project

query Parameters
project_path
required
string (Project Path)

Responses

Response samples

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

Content type
application/json
{ }

Response samples

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

Content type
application/json
{ }

Response samples

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 Tasks

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Task

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

Responses

Response samples

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 Run

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

Responses

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "input": "string",
  • "input_source": {
    },
  • "output": {
    },
  • "repair_instructions": "string",
  • "repaired_output": {
    },
  • "intermediate_outputs": {
    },
  • "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

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

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "input": "string",
  • "input_source": {
    },
  • "output": {
    },
  • "repair_instructions": "string",
  • "repaired_output": {
    },
  • "intermediate_outputs": {
    },
  • "tags": [ ],
  • "model_type": "string"
}

Get Runs

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Runs Summary

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "model_name": "string",
  • "provider": "string",
  • "plaintext_input": "string",
  • "structured_input": { },
  • "ui_prompt_method": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "input": "string",
  • "input_source": {
    },
  • "output": {
    },
  • "repair_instructions": "string",
  • "repaired_output": {
    },
  • "intermediate_outputs": {
    },
  • "tags": [ ],
  • "model_type": "string"
}