Skip to main content
POST
Share Experiment To Team

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
X-API-Key
string | null

Path Parameters

experiment_id
string<uuid>
required

Body

application/json

Request to share a personal experiment into a team workspace.

team_id
string<uuid>
required

Response

Successful Response

Experiment response.

anchor_field
string | null
required
comparison_policy
Comparison Policy · object
required
created_at
string<date-time>
required
description
string | null
required
id
string<uuid>
required
is_active
boolean
required
kind
enum<string>
required

Kinds of experiments (extensible).

Available options:
simple,
advanced
name
string
required
objective
enum<string>
required

User-facing objective for experiment behavior.

Available options:
benchmark,
optimization,
rlhf_loop
parameter_schema
Parameter Schema · object[] | null
required
team_id
string<uuid> | null
required
type
enum<string>
required

Types of experiments.

Available options:
image,
audio,
text,
video
updated_at
string<date-time>
required
user_id
string<uuid>
required
access_role
enum<string>
default:owner
Available options:
owner,
manager,
collaborator,
voter
access_scope
enum<string>
default:personal
Available options:
personal,
team
allow_playback_speed
boolean
default:false
allow_public_voting
boolean
default:false
axes
Axes · object[] | null
budget_cap_credits
integer | null
budget_remaining_credits
integer | null
budget_spent_credits
integer
default:0
can_manage_experiment
boolean
default:false
can_run_experiment
boolean
default:false
can_view_analysis
boolean
default:false
can_view_api
boolean
default:false
can_view_votes
boolean
default:false
confidence_score
number | null
default:0
enforce_playback
boolean
default:false
is_discoverable
boolean
default:false
is_public_readable
boolean
default:false
min_playback_percent
integer
default:0
min_viewing_seconds
integer
default:0
policy_version
string
default:v1
purchased_comparisons
integer
default:0
readiness_errors
Readiness Errors · object[]
readiness_state
enum<string>
default:ready

Readiness state for serving pairs.

Available options:
draft,
ready,
invalid,
blocked
remaining_comparisons
integer
default:0
require_feedback
boolean
default:false
requires_anchor
boolean
default:true
rlhf_policy
RlhfPolicy · object | null
sample_count
integer | null
default:0
score_count
integer
default:0
servable_pair_count
integer | null
default:0
status
enum<string>
default:paused

Lifecycle state for experiment operations.

Available options:
draft,
active,
paused,
completed,
archived
team_member_count
integer
default:0
team_name
string | null
total_votes
integer | null
default:0
used_comparisons
integer
default:0
vote_cost_credits
integer
default:1