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

Activate a pairing session

POST
/v1/private/pairing/sessions/:sessionId/activate
POST
/api/v1/private/pairing/sessions/:sessionId/activate
$curl -X POST http://localhost:5173/api/v1/private/pairing/sessions/sessionId/activate \
>     -H "Content-Type: application/json" \
>     -d '{
>  "runner_name": "opik-runner-01",
>  "hmac": "dGhpcy1pcy1hLTI4LWJ5dGUtaG1hYw=="
>}'
1{}
Verify the activation HMAC and flip the runner row to CONNECTED
Was this page helpful?
Previous

Create a pairing session

Next
Built with

Path parameters

sessionIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
runner_namestringRequired0-128 characters
hmacstringRequired43-44 characters

Response headers

Locationstring
URI of the runner

Response

Session activated

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error