NAME

OpenAPI::Client::OpenAI::Path::realtime-calls - Documentation for the /realtime/calls path.

OPERATIONS

POST /realtime/calls

create-realtime-call

$client->create_realtime_call({
    body => { ... },
});

Create a new Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection.

Responses

201 - Realtime call created successfully.

Content-Type: application/sdp

Example:

"string"

SCHEMAS

RealtimeCallCreateRequest

Properties:

  • sdp (string, required) - WebRTC Session Description Protocol (SDP) offer generated by the caller.

  • session (allOf) - Optional session configuration to apply before the realtime session is created. Use the same parameters you would send in a create client secret request.

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2026 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.