Start a training session

curl --request POST \
  --url https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": {
    "input_mappings": {},
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kind": "table",
    "row_count": 10
  }
}
'

import requests

url = "https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/"

payload = { "source": {
        "input_mappings": {},
        "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "table",
        "row_count": 10
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source: {
      input_mappings: {},
      table_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      kind: 'table',
      row_count: 10
    }
  })
};

fetch('https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source' => [
        'input_mappings' => [
                
        ],
        'table_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'kind' => 'table',
        'row_count' => 10
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/"

	payload := strings.NewReader("{\n  \"source\": {\n    \"input_mappings\": {},\n    \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"kind\": \"table\",\n    \"row_count\": 10\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": {\n    \"input_mappings\": {},\n    \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"kind\": \"table\",\n    \"row_count\": 10\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source\": {\n    \"input_mappings\": {},\n    \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"kind\": \"table\",\n    \"row_count\": 10\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "cycle": 123,
  "error": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "progress": {
    "done": 123,
    "failed": 123,
    "total": 123
  },
  "proposal": {
    "changed": true,
    "current_prompt": "<string>",
    "proposed_prompt": "<string>"
  },
  "rows": [
    {
      "confidence": "high",
      "credits_charged": 123,
      "cycle": 123,
      "error": "<string>",
      "error_class": "timeout",
      "feedback": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inputs": {},
      "outcome": "succeeded",
      "position": 123,
      "prior_feedback": [
        {
          "cycle": 123,
          "feedback": "<string>",
          "verdict": "good"
        }
      ],
      "reasoning": "<string>",
      "skipped_reason": "<string>",
      "sources": [
        "<string>"
      ],
      "status": "pending",
      "steps": [
        {
          "action": "search",
          "detail": "<string>",
          "observation": "<string>",
          "duration_ms": 123,
          "outcome": "completed",
          "thought": "<string>"
        }
      ],
      "verdict": "good",
      "changed_fields": [
        "<string>"
      ],
      "previous_value": "<unknown>",
      "previous_verdict": "good",
      "value": "<unknown>"
    }
  ],
  "saved_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_input_mappings": {},
  "source_kind": "table",
  "source_table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

POST

agent-training

saved-agents

{saved_agent_id}

sessions

Start a training session

curl --request POST \
  --url https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": {
    "input_mappings": {},
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kind": "table",
    "row_count": 10
  }
}
'

import requests

url = "https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/"

payload = { "source": {
        "input_mappings": {},
        "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "table",
        "row_count": 10
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source: {
      input_mappings: {},
      table_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      kind: 'table',
      row_count: 10
    }
  })
};

fetch('https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source' => [
        'input_mappings' => [
                
        ],
        'table_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'kind' => 'table',
        'row_count' => 10
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/"

	payload := strings.NewReader("{\n  \"source\": {\n    \"input_mappings\": {},\n    \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"kind\": \"table\",\n    \"row_count\": 10\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": {\n    \"input_mappings\": {},\n    \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"kind\": \"table\",\n    \"row_count\": 10\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/agent-training/saved-agents/{saved_agent_id}/sessions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source\": {\n    \"input_mappings\": {},\n    \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"kind\": \"table\",\n    \"row_count\": 10\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "cycle": 123,
  "error": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "progress": {
    "done": 123,
    "failed": 123,
    "total": 123
  },
  "proposal": {
    "changed": true,
    "current_prompt": "<string>",
    "proposed_prompt": "<string>"
  },
  "rows": [
    {
      "confidence": "high",
      "credits_charged": 123,
      "cycle": 123,
      "error": "<string>",
      "error_class": "timeout",
      "feedback": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "inputs": {},
      "outcome": "succeeded",
      "position": 123,
      "prior_feedback": [
        {
          "cycle": 123,
          "feedback": "<string>",
          "verdict": "good"
        }
      ],
      "reasoning": "<string>",
      "skipped_reason": "<string>",
      "sources": [
        "<string>"
      ],
      "status": "pending",
      "steps": [
        {
          "action": "search",
          "detail": "<string>",
          "observation": "<string>",
          "duration_ms": 123,
          "outcome": "completed",
          "thought": "<string>"
        }
      ],
      "verdict": "good",
      "changed_fields": [
        "<string>"
      ],
      "previous_value": "<unknown>",
      "previous_verdict": "good",
      "value": "<unknown>"
    }
  ],
  "saved_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_input_mappings": {},
  "source_kind": "table",
  "source_table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

saved_agent_id

string<uuid>

required

Body

application/json

Where a new training session takes its inputs from.

source

TrainingTableSourceSchema · object

required

Training inputs read from a table, one row per record.

TrainingTableSourceSchema
TrainingManualSourceSchema

Show child attributes

Response

Successful Response

A whole training session, as the reviewer's page polls it.

Everything the page needs in one payload: the phase (status), the cycle, the rows with their results and critiques, and the pending proposal when there is one.

created_at

string<date-time>

required

cycle

integer

required

error

string | null

required

string<uuid>

required

progress

TrainingProgressSchema · object

required

How far the current cycle's run has got.

Show child attributes

proposal

TrainingProposalSchema · object | null

required

A pending prompt revision, alongside what it would replace.

Show child attributes

rows

TrainingRowReadSchema · object[]

required

Show child attributes

saved_agent_id

string<uuid>

required

source_input_mappings

Source Input Mappings · object

required

Show child attributes

source_kind

enum<string>

required

Where a session's training inputs came from.

Available options:

table,

manual

source_table_id

string<uuid> | null

required

status

enum<string>

required

Where a training session stands — the state the reviewer's screen shows.

One enum rather than a separate lifecycle flag and phase, because the phase IS the state: a session is either waiting on the machine (RUNNING), waiting on the reviewer (REVIEWING, PROPOSED), or finished. Callers never derive the screen from row counts.

Available options:

running,

reviewing,

proposed,

completed,

abandoned

updated_at

string<date-time>

required

API reference

Endpoints

Start a training session

Authorizations

Path Parameters

Body

Response