Skip to main content
POST
Start a Team run from an optional skill and prompt, or a script

Authorizations

Authorization
string
header
required

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

Body

application/json
vmPreset
string
Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
permissionPreset
string
Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
modelPreset
string
Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
attachments
object[]
Maximum array length: 16
requiresVm
boolean
prompt
string
Required string length: 1 - 50000
script
string
deprecated

Retired: returns scripts_retired. Use an agent skill to execute code.

Required string length: 1 - 200000
skill
string
Required string length: 1 - 64
name
string
Required string length: 1 - 120
executionConfigId
string
Minimum string length: 1
modelAccountId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
vmImage
string
Maximum string length: 512
Pattern: ^(?:(?:(?:[A-Za-z0-9]+(?:[._-][A-Za-z0-9]+)*\/)?[A-Za-z0-9]+(?:[._-][A-Za-z0-9]+)*(?:\/[A-Za-z0-9]+(?:[._-][A-Za-z0-9]+)*)*(?::[A-Za-z0-9_][A-Za-z0-9_.-]{0,127})?(?:@sha256:[a-f0-9]{64})?))?$
model
string
Maximum string length: 120
runScopes
enum<string>[]

Factorize application permissions to grant. Omission inherits effective client permissions and an empty list grants none.

Maximum array length: 13
Available options:
team:read,
team:write,
triggers:read,
triggers:write,
runs:read,
runs:invoke,
runs:start,
runs:cancel,
runs:write,
integrations:read,
integrations:write,
skills:read,
skills:write
integrationIds
string<uuid>[]
Maximum array length: 100
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
inputs
object
idempotencyKey
string
Required string length: 1 - 200

Response

Accepted run

runId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
url
string<uri>
required
outcomeUri
string
required
duplicate
boolean
required