Skip to main content
API docs by Redocly

Inference API (1.0)

Download OpenAPI specification:Download

This is the API documentation for the Inference backend.

action groups

Get all action groups

Retrieve a list of action groups with pagination

query Parameters
limit
integer
Default: 10

limit

after
string

after

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create action group

Create a new action group

Request Body schema: application/json
required

Action Group creation request

description
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string"
}

Delete action group

Delete an action group by ID

path Parameters
id
required
string

Action group ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get action group

Retrieve an action group by ID

path Parameters
id
required
string

Action Group ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string"
}

Update action group

Update an action group by ID

path Parameters
id
required
string

Action group ID

Request Body schema: application/json
required

Action group update request

description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string"
}

actions

Get all actions

Retrieve a list of actions with pagination

query Parameters
limit
integer
Default: 10

limit

after
string

after

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create action

Create a new action

Request Body schema: application/json
required

Action creation request

channel
string
channel_template
string
custom_insights
string
description
required
string
end_date
string
model_id
string
name
required
string
priority
required
string (model.ActionPriority)
Enum: "very_low" "low" "medium" "high" "very_high"
start_date
string
status
string (model.ActionStatus)
Enum: "archived" "draft" "active" "inactive"
type
required
string

Responses

Request samples

Content type
application/json
{
  • "channel": "string",
  • "channel_template": "string",
  • "custom_insights": "string",
  • "description": "string",
  • "end_date": "string",
  • "model_id": "string",
  • "name": "string",
  • "priority": "very_low",
  • "start_date": "string",
  • "status": "archived",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "channel": "string",
  • "channel_template": "string",
  • "created_at": "string",
  • "custom_insights": "string",
  • "description": "string",
  • "end_date": "string",
  • "group": "string",
  • "id": "string",
  • "model_id": "string",
  • "name": "string",
  • "priority": "very_low",
  • "start_date": "string",
  • "status": "archived",
  • "type": "string",
  • "updated_at": "string"
}

Delete action

Delete an action by ID

path Parameters
id
required
string

Action ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get action

Retrieve an action by ID

path Parameters
id
required
string

Action ID

Responses

Response samples

Content type
application/json
{
  • "channel": "string",
  • "channel_template": "string",
  • "created_at": "string",
  • "custom_insights": "string",
  • "description": "string",
  • "end_date": "string",
  • "group": "string",
  • "id": "string",
  • "model_id": "string",
  • "name": "string",
  • "priority": "very_low",
  • "start_date": "string",
  • "status": "archived",
  • "type": "string",
  • "updated_at": "string"
}

Update action

Update an action by ID

path Parameters
id
required
string

Action ID

Request Body schema: application/json
required

Action update request

channel
string
channel_template
string
custom_insights
string
description
string
end_date
string <date-time>
group
string
model_id
string
name
string
priority
string (model.ActionPriority)
Enum: "very_low" "low" "medium" "high" "very_high"
start_date
string <date-time>
status
string (model.ActionStatus)
Enum: "archived" "draft" "active" "inactive"
type
string

Responses

Request samples

Content type
application/json
{
  • "channel": "string",
  • "channel_template": "string",
  • "custom_insights": "string",
  • "description": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "group": "string",
  • "model_id": "string",
  • "name": "string",
  • "priority": "very_low",
  • "start_date": "2019-08-24T14:15:22Z",
  • "status": "archived",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "channel": "string",
  • "channel_template": "string",
  • "created_at": "string",
  • "custom_insights": "string",
  • "description": "string",
  • "end_date": "string",
  • "group": "string",
  • "id": "string",
  • "model_id": "string",
  • "name": "string",
  • "priority": "very_low",
  • "start_date": "string",
  • "status": "archived",
  • "type": "string",
  • "updated_at": "string"
}

arguments

Find all arguments

Find all arguments with optional query parameters

query Parameters
status
string
Enum: "pending" "waiting_review" "success" "failed" "reviewing"

Review status filter

action_id
string

Action ID filter

page
integer
Default: 1

Page number

page_size
integer
Default: 100

Page size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create argument completion

Generate an argument completion based on provided messages and parameters

Request Body schema: application/json
required

Argument from score request with messages and parameters

action_id
string
required
object
echo
boolean
required
object (model.InsightSpec)
max_tokens
integer
model
required
string
required
object (model.ProductSpec)
temperature
number
top_p
number

Responses

Request samples

Content type
application/json
{
  • "action_id": "string",
  • "client": {
    },
  • "echo": true,
  • "insight_spec": {
    },
  • "max_tokens": 0,
  • "model": "string",
  • "product": {
    },
  • "temperature": 0,
  • "top_p": 0
}

Response samples

Content type
application/json
{
  • "action_id": "string",
  • "argument": "string",
  • "argument_thinking": "string",
  • "client": {
    },
  • "created_at": "string",
  • "duration": 0,
  • "error": "string",
  • "id": "string",
  • "insight_spec": {
    },
  • "product": {
    },
  • "review": {
    },
  • "updated_at": "string"
}

Delete an argument

Delete an argument by ID

path Parameters
id
required
string

Argument ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Find an argument

Find an argument by ID

path Parameters
id
required
string

Argument ID

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "action_id": "string",
  • "argument": "string",
  • "argument_thinking": "string",
  • "client": {
    },
  • "created_at": "string",
  • "deleted_at": "string",
  • "id": "string",
  • "insight_spec": {
    },
  • "product": {
    },
  • "review": {
    },
  • "space": "string",
  • "updated_at": "string"
}

Update an argument

Update an argument by ID. Possible review status values: pending, waiting_review, success, failed, reviewing

path Parameters
id
required
string

Argument ID

Request Body schema: application/json
required

Argument update request

action_id
string
argument
string
argument_thinking
string
object
object (model.InsightSpec)
object (model.ProductSpec)
object (model.ArgumentReview)

Responses

Request samples

Content type
application/json
{
  • "action_id": "string",
  • "argument": "string",
  • "argument_thinking": "string",
  • "client": {
    },
  • "insight_spec": {
    },
  • "product": {
    },
  • "review": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "action_id": "string",
  • "argument": "string",
  • "argument_thinking": "string",
  • "client": {
    },
  • "created_at": "string",
  • "deleted_at": "string",
  • "id": "string",
  • "insight_spec": {
    },
  • "product": {
    },
  • "review": {
    },
  • "space": "string",
  • "updated_at": "string"
}

benchmarks

Get all benchmarks

Retrieve a list of benchmarks with pagination

query Parameters
page_size
integer
Default: 10

Page size

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create benchmark

Create a new benchmark

Request Body schema: application/json
required

Benchmark creation request

required
Array of objects (request.ConnectorTraining)
description
required
string
metrics
required
Array of strings (model.Metric)
Items Enum: "accuracy" "f1" "precision" "recall" "roc_auc" "log_loss" "ks" "gini"
name
required
string
task
required
string

Responses

Request samples

Content type
application/json
{
  • "connectors": [
    ],
  • "description": "string",
  • "metrics": [
    ],
  • "name": "string",
  • "task": "string"
}

Response samples

Content type
application/json
{
  • "connectors": [
    ],
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "metrics": [
    ],
  • "name": "string",
  • "task": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

Delete benchmark

Delete a benchmark by ID

path Parameters
id
required
string

Benchmark ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get benchmark

Retrieve a benchmark by ID

path Parameters
id
required
string

Benchmark ID

Responses

Response samples

Content type
application/json
{
  • "connectors": [
    ],
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "metrics": [
    ],
  • "name": "string",
  • "task": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

Update benchmark

Update a benchmark by ID

path Parameters
id
required
string

Benchmark ID

Request Body schema: application/json
required

Benchmark update request

connector
string
description
string
metrics
Array of strings (model.Metric)
Items Enum: "accuracy" "f1" "precision" "recall" "roc_auc" "log_loss" "ks" "gini"
name
string
task
string

Responses

Request samples

Content type
application/json
{
  • "connector": "string",
  • "description": "string",
  • "metrics": [
    ],
  • "name": "string",
  • "task": "string"
}

Response samples

Content type
application/json
{
  • "connectors": [
    ],
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "metrics": [
    ],
  • "name": "string",
  • "task": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

chats

List chats

Retrieve a paginated list of chat conversations, optionally filtered by name

query Parameters
limit
integer
Default: 10

limit

after
string

after

name
string

Filter chats by name

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create chat completion

Generate a chat completion based on provided messages and parameters

Request Body schema: application/json
required

Chat completion request with messages and parameters

echo
boolean
expert_ids
Array of strings
guard_enabled
boolean
guard_reasoning_enabled
boolean
id
string
max_tokens
integer
Array of objects (request.Message)
object
model
string
name
string
router_enabled
boolean
router_reasoning_enabled
boolean
stream
boolean
tags
Array of strings
temperature
number
top_p
number
type
string
user
string

Responses

Request samples

Content type
application/json
{
  • "echo": true,
  • "expert_ids": [
    ],
  • "guard_enabled": true,
  • "guard_reasoning_enabled": true,
  • "id": "string",
  • "max_tokens": 0,
  • "messages": [
    ],
  • "metadata": {
    },
  • "model": "string",
  • "name": "string",
  • "router_enabled": true,
  • "router_reasoning_enabled": true,
  • "stream": true,
  • "tags": [
    ],
  • "temperature": 0,
  • "top_p": 0,
  • "type": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "choices": [
    ],
  • "created_at": "string",
  • "guard": {
    },
  • "id": "string",
  • "model": "string",
  • "object": "string",
  • "router": {
    },
  • "usage": {
    }
}

Delete chat

Delete an chat by ID

path Parameters
id
required
string

Chat ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get chat history

Retrieve a chat conversation by its unique identifier

path Parameters
id
required
string

Chat identifier

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "id": "string",
  • "messages": [
    ],
  • "name": "string"
}

Update chat

Update an chat by ID

path Parameters
id
required
string

Chat ID

Request Body schema: application/json
required

Chat update request

guard_enabled
boolean
object (model.ChatResponse)
max_tokens
integer
Array of objects (model.Message)
model
string
name
string
router_enabled
boolean
temperature
number

Responses

Request samples

Content type
application/json
{
  • "guard_enabled": true,
  • "last_response": {
    },
  • "max_tokens": 0,
  • "messages": [
    ],
  • "model": "string",
  • "name": "string",
  • "router_enabled": true,
  • "temperature": 0
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "id": "string",
  • "messages": [
    ],
  • "name": "string"
}

Get chat history window

Retrieve a chat with a window of the conversation

path Parameters
id
required
string

Chat identifier

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "id": "string",
  • "messages": [
    ],
  • "name": "string"
}

checkpoints

List checkpoints

List checkpoints by ID

query Parameters
limit
integer
Default: 10

Limit

after
string
Default: "\"\""

After

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

clusters

Delete cluster

Delete a cluster by space

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get cluster

Retrieve a cluster by space

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Responses

Response samples

Content type
application/json
{
  • "inference": {
    },
  • "ingress": {
    },
  • "nodes": [
    ],
  • "resources": {
    }
}

Create cluster

Create a new cluster

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Request Body schema: application/json
required

Cluster creation request

ingress_url
required
string
manager_url
required
string
name
string
token
string

Responses

Request samples

Content type
application/json
{
  • "ingress_url": "string",
  • "manager_url": "string",
  • "name": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "id": "string",
  • "ingress_url": "string",
  • "manager_url": "string",
  • "name": "string",
  • "token": "string",
  • "updated_at": "string"
}

Update cluster

Update a cluster by space

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Request Body schema: application/json
required

Cluster update request

ingress_url
string
manager_url
string
token
string

Responses

Request samples

Content type
application/json
{
  • "ingress_url": "string",
  • "manager_url": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "id": "string",
  • "ingress_url": "string",
  • "manager_url": "string",
  • "name": "string",
  • "token": "string",
  • "updated_at": "string"
}

connectors

List connectors

Retrieve a list of connectors with pagination

query Parameters
limit
integer
Default: 10

limit

after
string

after

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create connector

Create a new connector

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Request Body schema: application/json
required

Connector creation request

name
required
string
object (request.S3Config)
type
required
string
Value: "aws-s3"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "s3": {
    },
  • "type": "aws-s3"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "id": "string",
  • "name": "string",
  • "provider": "string",
  • "region": "string",
  • "status": "string"
}

Delete connector

Delete a connector by ID

path Parameters
id
required
string

Connector ID

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get connector

Retrieve a connector by ID

path Parameters
id
required
string

Connector ID

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "id": "string",
  • "name": "string",
  • "provider": "string",
  • "region": "string",
  • "status": "string"
}

List files in a connector (S3)

List files for a connector by ID (currently supports S3 connectors)

path Parameters
id
required
string

Connector ID

query Parameters
prefix
string

File prefix filter

limit
integer

Maximum number of files to return

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Scan connector

Scan a connector by ID

path Parameters
id
required
string

Connector ID

header Parameters
Authorization
required
string
Default: Bearer <Add access token here>

Insert your access token

Request Body schema: application/json
required

Scan connector request

files
Array of strings

Responses

Request samples

Content type
application/json
{
  • "files": [
    ]
}

Response samples

Content type
application/json
{ }

data-models

Get all data models

Retrieve a list of data models with pagination

query Parameters
limit
integer
Default: 10

limit

after
string

after

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create data model

Create a new data model

Request Body schema: application/json
required

Data model creation request

description
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string"
}

Delete data model

Delete a data model by ID

path Parameters
id
required
string

Data model ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get data model

Retrieve a data model by ID

path Parameters
id
required
string

Data model ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string"
}

Update data model

Update a data model by ID

path Parameters
id
required
string

Data model ID

Request Body schema: application/json
required

Data model update request

description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string"
}

evaluations

Create evaluation

Create a new evaluation

Request Body schema: application/json
required

Evaluation creation request

benchmark_id
required
string
checkpoint_id
required
string
gpu_count
required
integer

Responses

Request samples

Content type
application/json
{
  • "benchmark_id": "string",
  • "checkpoint_id": "string",
  • "gpu_count": 0
}

Response samples

Content type
application/json
{
  • "benchmark_id": "string",
  • "checkpoint_id": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "gpu_count": 0,
  • "id": "string",
  • "result": {
    },
  • "updated_at": "string",
  • "updated_by": "string"
}

experts

List all experts

Get a comprehensive list of all available experts

query Parameters
limit
integer
Default: 10

limit

after
string

after

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create expert

Create a new expert with custom configuration and prompt templates

Request Body schema: application/json
required

Expert configuration data

context
string
description
required
string
Array of objects
name
required
string
Array of objects (model.ExpertTool)

Responses

Request samples

Content type
application/json
{
  • "context": "string",
  • "description": "string",
  • "file_context": [
    ],
  • "name": "string",
  • "tools": [
    ]
}

Response samples

Content type
application/json
{
  • "context": "string",
  • "created_at": "string",
  • "description": "string",
  • "file_context": [
    ],
  • "id": "string",
  • "name": "string",
  • "tools": [
    ],
  • "updated_at": "string"
}

Delete expert

Permanently remove an expert configuration by ID

path Parameters
id
required
string

Expert unique identifier

Responses

Get expert details

Retrieve a specific expert's complete configuration by ID

path Parameters
id
required
string

Expert unique identifier

Responses

Response samples

Content type
application/json
{
  • "context": "string",
  • "created_at": "string",
  • "description": "string",
  • "file_context": [
    ],
  • "id": "string",
  • "name": "string",
  • "tools": [
    ],
  • "updated_at": "string"
}

Update expert configuration

Modify an existing expert's configuration by ID

path Parameters
id
required
string

Expert unique identifier

Request Body schema: application/json
required

Updated expert configuration

context
string
description
string
Array of objects
name
string
Array of objects (model.ExpertTool)

Responses

Request samples

Content type
application/json
{
  • "context": "string",
  • "description": "string",
  • "file_context": [
    ],
  • "name": "string",
  • "tools": [
    ]
}

Response samples

Content type
application/json
{
  • "context": "string",
  • "created_at": "string",
  • "description": "string",
  • "file_context": [
    ],
  • "id": "string",
  • "name": "string",
  • "tools": [
    ],
  • "updated_at": "string"
}

inference-logs

Get inference logs

Retrieve paginated inference logs with various filtering options

query Parameters
start_date
string

Start date (format: 2006-01-02T15:04:05Z07:00)

end_date
string

End date (format: 2006-01-02T15:04:05Z07:00)

user
string

User ID filter

model
string

Model name filter

status
string

Status filter (success, error)

type
string

Request type filter

tag
string

Tag filter

correlation_id
string

Correlation ID filter

page
integer

Page number (default: 1)

page_size
integer

Page size (default: 20)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Get inference logs summary

Retrieve aggregated statistics for inference logs within a specified time period

query Parameters
start_date
string

Start date (format: 2006-01-02T15:04:05Z07:00)

end_date
string

End date (format: 2006-01-02T15:04:05Z07:00)

user
string

User ID filter

model
string

Model name filter

type
string

Request type filter

correlation_id
string

Correlation ID filter

Responses

Response samples

Content type
application/json
{
  • "avg_latency_ms": 0,
  • "input_tokens": 0,
  • "model_usage": {
    },
  • "output_tokens": 0,
  • "period_end_date": "string",
  • "period_start_date": "string",
  • "success_rate": 0,
  • "total_calls": 0,
  • "total_tokens": 0
}

insights

Create Insight

Create a new Insight conversation

Request Body schema: application/json
required

Insight creation request

actions
Array of strings
client
string
echo
boolean
max_tokens
integer
model
string
temperature
number
top_p
number

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ],
  • "client": "string",
  • "echo": true,
  • "max_tokens": 0,
  • "model": "string",
  • "temperature": 0,
  • "top_p": 0
}

Response samples

Content type
application/json
{
  • "actions": "string",
  • "argument": "string",
  • "argument_content": "string",
  • "argument_thinking": "string",
  • "best_channel": "string",
  • "best_time": "string",
  • "elapsed_time_in_seconds": 0,
  • "error": "string",
  • "finish_reason": "string",
  • "id": "string",
  • "insight": "string",
  • "thinking": "string",
  • "timeliness": "string",
  • "type": "string",
  • "usage": {
    }
}

leaderboards

List leaderboards

Retrieve a paginated list of leaderboards with rankings based on checkpoint performance

query Parameters
limit
integer
Default: 10

Limit

after
string
Default: "\"\""

After

model_id
string

Filter by model/checkpoint ID

benchmarks
Array of strings

Filter by benchmark IDs (can be multiple)

trainings
Array of strings

Filter by training IDs (can be multiple)

start_date
string

Filter by start date (RFC3339 format, e.g., 2024-01-01T00:00:00Z)

end_date
string

Filter by end date (RFC3339 format, e.g., 2024-12-31T23:59:59Z)

order_by_metric.benchmark_id
string

Order by metric from specific benchmark (optional: if omitted, averages across all benchmarks)

order_by_metric.metric_name
string

Order by this metric name

order_by_metric.direction
string
Default: "desc"

Order direction: asc or desc

name
string

Filter by checkpointname

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

users

Get logged user informations

Get logged user informations

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "external_id": "string",
  • "first_name": "string",
  • "id": "string",
  • "last_name": "string",
  • "permissions": [
    ],
  • "role": "designer",
  • "spaces": [
    ]
}

Update user

Update user

Request Body schema: application/json
required

Update user request

first_name
string
last_name
string
role
string (model.UserRole)
Enum: "designer" "developer"

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "role": "designer"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "external_id": "string",
  • "first_name": "string",
  • "id": "string",
  • "last_name": "string",
  • "role": "designer"
}

Add permissions to a user

Add permissions to a user

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ]
}

Accept invite

Accept invite

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

models

List inference models

Retrieve a list of available inference models from the inference server

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

personas

List personas

Get a paginated list of all personas

query Parameters
limit
integer
Default: 10

limit

after
string

after

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create persona

Create a new persona with provided data

Request Body schema: application/json
required

Persona data

birthdate
required
string
object
name
required
string
notes
required
string

Responses

Request samples

Content type
application/json
{
  • "birthdate": "string",
  • "data": {
    },
  • "name": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "birthdate": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "data": {
    },
  • "id": "string",
  • "name": "string",
  • "notes": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

Delete persona

Permanently remove a persona by ID

path Parameters
id
required
string

Persona unique identifier

Responses

Get persona details

Retrieve a specific persona by ID

path Parameters
id
required
string

Persona unique identifier

Responses

Response samples

Content type
application/json
{
  • "birthdate": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "data": {
    },
  • "id": "string",
  • "name": "string",
  • "notes": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

Update persona

Modify an existing persona by ID

path Parameters
id
required
string

Persona unique identifier

Request Body schema: application/json
required

Updated persona data

birthdate
string
object
name
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "birthdate": "string",
  • "data": {
    },
  • "name": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "birthdate": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "data": {
    },
  • "id": "string",
  • "name": "string",
  • "notes": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

Generate persona completion

Create a persona completion based on prompt and existing data

Request Body schema: application/json
required

Completion request with prompt and context

object
Array of objects
prompt
string

Responses

Request samples

Content type
application/json
{
  • "current_persona": {
    },
  • "history": [
    ],
  • "prompt": "string"
}

Response samples

Content type
application/json
{ }

Upload persona files

Process files to extract and create personas

Request Body schema: multipart/form-data
required
files
required
string <binary>

Files containing persona data

Responses

Response samples

Content type
application/json
{
  • "conflict_personas": 0,
  • "message": "string",
  • "status": "string",
  • "total": 0,
  • "upload_token": "string"
}

Confirm pending persona upload

Finalize a pending persona upload with conflict resolution strategy

path Parameters
upload_token
required
string

Upload token from previous upload response

Request Body schema: application/json
required

Conflict resolution strategy

conflict_resolution
string

"overwrite", "create", or "skip"

Responses

Request samples

Content type
application/json
{
  • "conflict_resolution": "string"
}

Response samples

Content type
application/json
{
  • "conflicts_resolved": 0,
  • "message": "string",
  • "status": "string",
  • "total_uploaded": 0
}

spaces

Get all spaces

Retrieve all spaces

query Parameters
limit
integer
Default: 10

Limit

after
string
Default: "\"\""

After

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create space

Create a new space

Request Body schema: application/json
required

Space creation request

description
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

Delete space

Delete a space by ID

path Parameters
id
required
string

Space ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get space

Retrieve a space by ID

path Parameters
id
required
string

Space ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

Update space

Update a space by ID

path Parameters
id
required
string

Space ID

Request Body schema: application/json
required

Space update request

description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string",
  • "updated_by": "string"
}

Invite space

Invite a user to a space

path Parameters
id
required
string

Space ID

Request Body schema: application/json
required

Invite space request

emails
required
Array of strings
roles
required
Array of strings (permissions.UserPermission)
Items Enum: "benchmarks:create" "benchmarks:get" "benchmarks:list" "evaluations:create" "leaderboards:list" "trainings:create" "trainings:delete" "trainings:get" "trainings:list" "trainings:update" "data-models:create" "data-models:delete" "data-models:get" "data-models:list" "data-models:update"

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "emails": [
    ]
}

Restore space

Restore a deleted space by ID

path Parameters
id
required
string

Space ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

trainings

Get all trainings

Retrieve a list of training jobs with pagination

query Parameters
pageSize
integer
Default: 10

pageSize

page
integer
Default: 1

page

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "data": [
    ],
  • "has_more": true
}

Create training

Create a new training job

Request Body schema: application/json
required

Training creation request

architecture
required
string
benchmark_ids
Array of strings
configuration
required
object
required
Array of objects (request.ConnectorTraining)
data_model_id
required
string
gpu_count
required
integer
name
required
string

Responses

Request samples

Content type
application/json
{
  • "architecture": "string",
  • "benchmark_ids": [
    ],
  • "configuration": { },
  • "connectors": [
    ],
  • "data_model_id": "string",
  • "gpu_count": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "architecture": "string",
  • "benchmark_ids": [
    ],
  • "checkpoints": [
    ],
  • "configuration": { },
  • "connectors": [
    ],
  • "created_at": "string",
  • "data_model_id": "string",
  • "gpu_count": 0,
  • "id": "string",
  • "metrics": [
    ],
  • "name": "string",
  • "status": "string",
  • "updated_at": "string"
}

Delete training

Delete a training job by ID

path Parameters
id
required
string

Training ID

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Get training

Retrieve a training job by ID

path Parameters
id
required
string

Training ID

Responses

Response samples

Content type
application/json
{
  • "architecture": "string",
  • "benchmark_ids": [
    ],
  • "checkpoints": [
    ],
  • "configuration": { },
  • "connectors": [
    ],
  • "created_at": "string",
  • "data_model_id": "string",
  • "gpu_count": 0,
  • "id": "string",
  • "metrics": [
    ],
  • "name": "string",
  • "status": "string",
  • "updated_at": "string"
}

Update training

Update a training job by ID

path Parameters
id
required
string

Training ID

Request Body schema: application/json
required

Training update request

architecture
string
benchmark_ids
Array of strings
configuration
object
object (request.UpdateConnectorTraining)
name
string

Responses

Request samples

Content type
application/json
{
  • "architecture": "string",
  • "benchmark_ids": [
    ],
  • "configuration": { },
  • "connector": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "architecture": "string",
  • "benchmark_ids": [
    ],
  • "checkpoints": [
    ],
  • "configuration": { },
  • "connectors": [
    ],
  • "created_at": "string",
  • "data_model_id": "string",
  • "gpu_count": 0,
  • "id": "string",
  • "metrics": [
    ],
  • "name": "string",
  • "status": "string",
  • "updated_at": "string"
}

webhooks

Webhook to receive status updates

Receives status updates for all entities (webhook endpoint)

Request Body schema: application/json
required

Webhook payload

event
string

e.g., "created", "updated", "deleted"

id
required
string
name
string
object
status
string
timestamp
string
type
string

e.g., "aws-s3", "postgres"

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "id": "string",
  • "name": "string",
  • "payload": {
    },
  • "status": "string",
  • "timestamp": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}