Documentation | Refonte

Contact Sales Login

Introduction to Refonte.AI API

Introduction to Refonte.AI API Authentication Callbacks Secure Results URLs Errors

Data Engine Core Resources

Data Engine Tasks Types

Studio Teams

List All Teammates

Obtains essential data about every team member connected to your account.

Request

Python

GET  /v1/teams

import requests

url = "https://api.refonte.com/v1/teams"

headers = {
    "accept": "application/json",
    "authorization": "Basi c2NhbGVpbnRfZWMyMjU0MWQ2OWE1ND..."
}

response = requests.get(url, headers=headers)

print(response.text)

Invite Teammates

Sends out email invites to one or more members on your team. `team_role` has three possible roles: manager, member, and labeler. returns data pertaining to every team member.

Query Params

email string required

Array of emails of teammates you want to invite.

team_role string required

Role of invited teammate. Allowed values are: labeler (Studio only), member, or manager.

Request

Python

POST  /v1/teams/invite

import requests

url = "https://api.refonte.com/v1/teams/invite"

payload = {
    "emails": ["refonte@admin.com"],
    "team_role": "labeler"
}
headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlYWE..."
}

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

print(response.text)

Response

[
  {
    "email": "refonte@admin.com",
    "disableRapidEmails": false,
    "isStudioLabeler": false,
    "firstName": "lautaro",
    "lastName": "rangil",
    "company": "Refonte Ai",
    "role": "admin"
  },
  {
    "email": "refonte@admin.com",
    "disableRapidEmails": false,
    "isStudioLabeler": false,
    "role": "member"
  },
  {
    "email": "refonte@admin.com",
    "disableRapidEmails": false,
    "isStudioLabeler": false,
    "role": "member"
  }
]

Update Teammate Role

Modifies the non-administrator team members' roles. The emails on the team should be a list of those who are labelers, members, managers, or disabled. A manager, team member, or labeler should be the team role. provides data about every member of your team.

Query Params

email string required

Array of emails of teammates you want to invite.

team_role string required

Role of invited teammate. Allowed values are: labeler (Studio only), member, or manager.

Request

Python

POST  /v1/teams/set_role

import requests

url = "https://api.refonte.com/v1/teams/set_role"

headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlYWE0O.."
}

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

print(response.text)

Response

[
  {
    "email": "refonte@admin.com",
    "disableRapidEmails": false,
    "isStudioLabeler": false,
    "firstName": "lautaro",
    "lastName": "rangil",
    "company": "Refonte Ai",
    "role": "admin"
  },
  {
    "email": "refonte@admin.com",
    "disableRapidEmails": false,
    "isStudioLabeler": false,
    "role": "member"
  },
  {
    "email": "refonte@admin.com",
    "disableRapidEmails": false,
    "isStudioLabeler": false,
    "role": "member"
  },
  {
    "email": "refonte@admin.com",
    "expiry": "2023-08-09T16:12:38.072Z",
    "role": "invited",
    "isStudioLabeler": true
  }
]

List All Assignments

Gets the current project assignments of all active users in your team (does not include “invited” or “disabled” team members).

Request

Python

GET  /v1/studio/assignments

import requests

url = "https://api.refonte.com/v1/studio/assignments"

headers = {
    "accept": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlYWE0OTgy.."
}

response = requests.get(url, headers=headers)

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Assign Teammates

Gets the current project assignments of all active users in your team (does not include “invited” or “disabled” team members).

Query Params

email string required

Array of emails of teammates

Query Params

projects string

Array of projects to assign.

Request

Python

POST  /v1/studio/assignments/add

import requests

url = "https://api.refonte.com/v1/studio/assignments/add"

headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2O..."
}

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

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Unassign Teammate

Projects from certain team members that are not assigned. returns all assigned tasks to the team members.

Query Params

email string required

Array of emails of teammates

Query Params

projects string

Array of projects to unassign.

Request

Python

POST  /v1/studio/assignments/remove

import requests

url = "https://api.refonte.com/v1/studio/assignments/remove"

headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlYWE0OTgy..."
}

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

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

List Project Groups

Returns all labeler groups for the project specified in URL.

Query Params

project string required

Array of emails of teammates

Request

Python

GET  /v1/studio/projects/{project}/groups

import requests

url = "https://api.refonte.com/v1/studio/projects/project_name/groups"

headers = {
    "accept": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1ND..."
}

response = requests.get(url, headers=headers)

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Update Project Group

Team members are added or removed from a designated labeler group. Only provides details on that particular group.

Query Params

project string required

Array of emails of teammates

group string required

Request

Python

POST  /v1/studio/projects/{project}/groups/{group}

import requests

url = "https://api.refonte.com/v1/studio/projects/project_name/groups/group_name"

headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlYWE0O..."
}

response = requests.put(url, headers=headers)

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Studio Actions

List Studio Batches

Returns basic information about all pending batches, in order of priority.

Query Params

project string required

Array of emails of teammates

group string required

Request

Python

GET  /v1/studio/batches

import requests

url = "https://api.refonte.com/v1/studio/batches"

headers = {
    "accept": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlY....."
}

response = requests.get(url, headers=headers)

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Assign Batches

Sets the labeler group assignment for the given batch, not adds to it. Additionally, you can add specific members by adding their email as a group name. Simply provides information about the designated batch in return.

Query Params

batch string required

List of group names

Body Params

group string

Request

Python

POST  /v1/studio/batches/{batch}

import requests

url = "https://api.refonte.com/v1/studio/batches/batch_name"

headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlYWE0OTg..."
}

response = requests.put(url, headers=headers)

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Set Batches Priorities

Team members are added or removed from a designated labeler group. Only provides details on that particular group.

Query Params

group string

Request

Python

POST  /v1/studio/batches/set_priorities

import requests

url = "https://api.refonte.com/v1/studio/batches/set_priorities"

headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1ND...."
}

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

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Reset Batches Priorities

Returns the batch priority order to its initial position. Calibration batches are arranged by default, followed by creation date, puts each batch back in the original priority order.

Query Params

group string

Request

Python

POST  /v1/studio/batches/reset_priorities

import requests

url = "https://api.refonte.com/v1/studio/batches/reset_priorities"

headers = {
    "accept": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlYW..."
}

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

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

List Training Attempts

This API returns a list of training attempts matching the provided parameters and related data. You must set one of `quality_task_ids` or `labeler_emails` (or both) in the query parameters to use this endpoint.

Query Params

quality_task_ids array of strings

labeler_emails array of strings

next_token array of strings

limit int32

Request

Python

GET  /v1/quality/labelers

import requests

url = "https://api.refonte.com/v1/quality/labelers"

headers = {
    "accept": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlY..."
}

response = requests.get(url, headers=headers)

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Send Tasks to Completion

Sends unfinished assignments that require at least one try to be finished. All_batches takes precedence if you offer batches as an array of batch names and all_batches as true.

Query Params

projectName string required

List of group names

Query Params

all_batches boolean

batches array of strings

Request

Python

GET  /v1/studio/projects/{projectName}/send_tasks_to_completed

import requests

url =
  "https://api.refonte.com/v1/studio/projects/project_name/send_tasks_to_completed"

headers = {
    "content-type": "application/json",
    "authorization": "Basic c2NhbGVpbnRfZWMyMjU0MWQ2OWE1NDBlY...."
}

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

print(response.text)

Response

{
  "id": "Nc6yKKMpcxiiFxp6",
  "message_id": "LoPsJaMcPBuFNjg1",
  "filename": "Invoice_room_service__Plaza_Hotel.pdf",
  "file_url": "https://assets.invoice_room_service__Plaza_Hotel.pdf",
  "file_type": "application/pdf",
  "file_size": 21352,
  "created_at": 692233200
}

Update Project Config (Studio Only)

Studio projects only. This endpoint updates the pipeline config of your project. `/projects/[Name]/updatePipelineConfig is also a valid endpoint option.

Path Params

name string required

List of group names

Body Params

pipeline string

Studio projects only. Specify the pipeline of the project. Must use either `standard_task` or `consensus_task`.

consensus_attempts integer

Studio consensus projects only. Specify the number of attempts

Updated about 2 months ago