Create a pairing session | Opik Documentation

POST/v1/private/pairing/sessionsCreate a pairing session

Request body

application/json

objectCreateSessionRequest

activation_keystringrequired

maxLength 44 · minLength 43

project_idstring · uuidrequired

ttl_secondsinteger · int32

maximum 600 · minimum 60

typestringrequired

one of "connect", "endpoint"

Example request

{
  "activation_key": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "ttl_seconds": 0,
  "type": "connect"
}

Responses

objectCreateSessionResponse

runner_idstring · uuid

session_idstring · uuid

Example response

{
  "runner_id": "00000000-0000-0000-0000-000000000000",
  "session_id": "00000000-0000-0000-0000-000000000000"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/pairing/sessions' \
  -H 'Content-Type: application/json' \
  -d '{"activation_key":"string","project_id":"00000000-0000-0000-0000-000000000000","ttl_seconds":0,"type":"connect"}'

const response = await fetch('http://localhost:5173/api/v1/private/pairing/sessions', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"activation_key":"string","project_id":"00000000-0000-0000-0000-000000000000","ttl_seconds":0,"type":"connect"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/pairing/sessions', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"activation_key\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"ttl_seconds\":0,\"type\":\"connect\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/pairing/sessions",
    headers={"Content-Type": "application/json"},
    data='{"activation_key":"string","project_id":"00000000-0000-0000-0000-000000000000","ttl_seconds":0,"type":"connect"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"activation_key":"string","project_id":"00000000-0000-0000-0000-000000000000","ttl_seconds":0,"type":"connect"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/pairing/sessions", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/pairing/sessions");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"activation_key\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"ttl_seconds\":0,\"type\":\"connect\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/pairing/sessions"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"activation_key\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"ttl_seconds\":0,\"type\":\"connect\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/pairing/sessions")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"activation_key\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"ttl_seconds\":0,\"type\":\"connect\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/pairing/sessions");
request.Content = new StringContent("{\"activation_key\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"ttl_seconds\":0,\"type\":\"connect\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "runner_id": "00000000-0000-0000-0000-000000000000",
  "session_id": "00000000-0000-0000-0000-000000000000"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}