Skip to main content
POST
Python

Authorizations

X-Auth-Token
string
header
required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Body

application/json
protocol
enum<number>
required
Available options:
1
type
enum<string>
required
Available options:
register
sdk
object
required
instance
object
required
agents
object[]
required
Required array length: 1 - 100 elements

Response

The instance is registered

frame
object
required

The registered frame, or the refused frame with its reason.

instanceToken
string

The token the poll and frames endpoints are addressed with, in the X-Agent-Instance-Token header. Present when the register was accepted.

Last modified on August 31, 2026