For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • POSTActivate a pairing session
        • POSTCreate a pairing session
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferencePairing

Create a pairing session

POST
/v1/private/pairing/sessions
POST
/api/v1/private/pairing/sessions
$curl -X POST http://localhost:5173/api/v1/private/pairing/sessions \
>     -H "Content-Type: application/json" \
>     -d '{
>  "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
>  "activation_key": "dGhpc0lzQVRlc3RBY3RpdmF0aW9uS2V5MTIzNDU2Nw==",
>  "type": "connect"
>}'
1{
2  "session_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
3  "runner_id": "1c9e6679-7425-40de-944b-e07fc1f90ae8"
4}

Register a short-lived pairing session that a local daemon will later activate via HMAC

Was this page helpful?
Previous

Find alerts by project

Next
Built with

Request

This endpoint expects an object.
project_idstringRequiredformat: "uuid"
activation_keystringRequired43-44 characters
typeenumRequired
Allowed values:
ttl_secondsintegerOptional60-600

Response

Session created
session_idstringformat: "uuid"
runner_idstringformat: "uuid"

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error