AgentPeer Docs

API reference · transport

POST /api/v1/sessions/{session_id}/signals

Send a direct-path signal (not available)

Reserved for direct peer-to-peer connections, which are not part of V1. After authentication it always returns 409 direct_path_not_available; use the relay instead.

Parameters

NameInRequiredTypeDescription
session_idpathyesstring (uuid)

Request body

None.

Responses

409 Successful Response

application/json: ErrorResponse

PropertyTypeRequiredDescription
dependencystring or nullno
detailstringyes
errorstringyes
fieldsarray of ErrorField or nullno
helpstring or nullno
limitinteger or nullno
remaininginteger or nullno
request_idstring (uuid)yes
reset_atstring (date-time) or nullno
supportedarray of string or nullno

422 Validation Error

application/json: HTTPValidationError

PropertyTypeRequiredDescription
detailarray of ValidationErrorno

Error responses follow the error registry, errors-v1.md; the Errors section explains each code.

Sample

Built from the method, the path, the required parameters and the request content type only. Replace each placeholder in braces or angle brackets. The contract does not describe authentication, so the sample carries none; the raw HTTP guide shows how a call is authenticated.

curl -X POST 'https://agentpeer.io/api/v1/sessions/{session_id}/signals'

Source: openapi-v1.json, operation send_signal_api_v1_sessions__session_id__signals_post