List Realtime Sessions.

GET 
https://api.gabber.dev/v1/realtime/list

List all Realtime Sessions.

Request

Query Parameters

page string

Page token for pagination

Header Parameters

x-human-id string

When using x-api-key authentication, this header is used to scope requests to a specific human.

Responses

200

Realtime Sessions fetched successfully

application/json

Schema

Schema

next_pagestring
The token for the next page of results, or null if there are no more pages.
total_countintegerrequired
The total number of items.
values object[]required
The list of items.
Array [
idstringrequired
The unique identifier of the RealtimeSession.
statestringrequired
The current state of the RealtimeSession.
Possible values: [ended, in_progress, not_started]
created_atdate-timerequired
The time the RealtimeSession was created.
ended_atdate-time
The time the RealtimeSession ended.
projectstringrequired
The project identifier.
humanstring
The human identifier.
simulatedbooleanrequired
Whether the session is simulated or not.
config objectrequired
general objectrequired
time_limit_sintegernullable
The time limit in seconds for the RealtimeSession.
Default value: null
save_messagesbooleanrequired
Whether to save messages in the RealtimeSession. These will be saved to the context provided in the generative config. If no context is provided, a new context will be created when the session starts.
Default value: true
input objectrequired
Configuration for the output of the RealtimeSession.
interruptablebooleanrequired
Whether the system allows interruption during speech.
Default value: true
parallel_listeningbooleanrequired
Whether the AI should continue listening while speaking. If true, the AI will produce another response immediately after the first one. This is only relevant if interruptable is false.
Default value: false
generative objectrequired
Configuration for the generative AI in the RealtimeSession.
llm objectrequired
created_atdate-timerequired
idstringrequired
namestringrequired
projectstringnullable
typestringrequired
compliancebooleanrequired
descriptionstringrequired
voice_override object
created_atdate-timerequired
idstringrequired
namestringrequired
languagestringrequired
servicestringnullable
modelstringnullable
voicestringnullable
embeddingsnumber[]nullable
cartesia_voice_idstringnullable
elevenlabs_voice_idstringnullable
projectstringnullable
humanstringnullable
preview_urlstringnullable
pricing objectrequired
Pricing details for this voice
price_per_secondstringrequired
Price per second for using this voice
currencystringrequired
Currency for the price (e.g., USD)
product_namestringrequired
Name of the product in Stripe
tags object[]required
Tags associated with this voice
Array [
namestringrequired
Machine-readable tag name
human_namestringrequired
Human-readable tag name for display
]
_extra object
Extra configuration for the voice. Usually this is for internal purposes.
property name*any
Extra configuration for the voice. Usually this is for internal purposes.
persona object
created_atdate-timerequired
descriptionstringrequired
idstringrequired
image_urlstringnullable
namestringrequired
projectstringrequired
humanstringnullable
genderstringnullable
Possible values: [male, female]
tags object[]
Array [
human_namestringrequired
namestringrequired
]
voicestringrequired
scenario object
created_atdate-timerequired
idstringrequired
namestringrequired
projectstringrequired
promptstringrequired
humanstringnullable
context objectrequired
idstringrequired
created_atdate-timerequired
projectstringrequired
humanstring
latest_messages object[]required
Array [
idstringrequired
speaking_ended_atdate-time
speaking_started_atdate-time
created_atdate-timerequired
rolestringrequired
Possible values: [assistant, system, user, tool]
realtime_sessionstring
content object[]required
Array [
oneOf
ContextMessageContentText
typestringrequired
Possible values: [text]
textstring
]
tool_calls object[]
Array [
idstringrequired
typestringrequired
Possible values: [function, gabber_tool]
function objectrequired
namestringrequired
arguments objectrequired
property name*any
]
]
tool_definitions object[]required
The tool definitions to use for the generative AI.
Array [
idstringrequired
namestringrequired
descriptionstringrequired
parameters object[]required
Array [
namestringrequired
descriptionstringrequired
typestringrequired
Possible values: [string, number, boolean, object, array]
requiredbooleanrequired
defaultstring
]
call_settings objectrequired
idstringrequired
destination objectrequired
oneOf
ToolDefinitionCallSettingDestinationWebRequest
typestringrequired
Possible values: [web_request]
urlstringrequired
]
_extra object
Extra configuration for the generative AI. Usually this is for internal purposes.
property name*any
Extra configuration for the generative AI. Usually this is for internal purposes.
output objectrequired
Configuration for the output of the RealtimeSession.
stream_transcriptbooleanrequired
Whether to stream agent spoken transcript or send full transcript when it's available all at once.
speech_synthesis_enabledbooleanrequired
Whether to enable speech synthesis for the RealtimeSession.
Default value: true
answer_messagestring
The message for the agent to speak first when the human joins. If exluded the agent will not speak first.
data object[]required
Array [
typestringrequired
Possible values: [caller_phone_number, agent_phone_number]
valuestringrequired
]
_extra object
Extra configuration for the RealtimeSession. Usually this is for internal purposes.
property name*any
Extra configuration for the RealtimeSession. Usually this is for internal purposes.
]

Example (auto)

{
  "next_page": "string",
  "total_count": 0,
  "values": [
    {
      "id": "string",
      "state": "ended",
      "created_at": "2024-07-29T15:51:28.071Z",
      "ended_at": "2024-07-29T15:51:28.071Z",
      "project": "string",
      "human": "string",
      "simulated": true,
      "config": {
        "general": {
          "time_limit_s": 0,
          "save_messages": true
        },
        "input": {
          "interruptable": true,
          "parallel_listening": false
        },
        "generative": {
          "llm": {
            "created_at": "2024-07-29T15:51:28.071Z",
            "id": "string",
            "name": "string",
            "project": "string",
            "type": "string",
            "compliance": true,
            "description": "string"
          },
          "voice_override": {
            "created_at": "2024-07-29T15:51:28.071Z",
            "id": "string",
            "name": "string",
            "language": "string",
            "service": "string",
            "model": "string",
            "voice": "string",
            "embeddings": [
              0
            ],
            "cartesia_voice_id": "string",
            "elevenlabs_voice_id": "string",
            "project": "string",
            "human": "string",
            "preview_url": "string",
            "pricing": {
              "price_per_second": "string",
              "currency": "string",
              "product_name": "string"
            },
            "tags": [
              {
                "name": "string",
                "human_name": "string"
              }
            ],
            "_extra": {}
          },
          "persona": {
            "created_at": "2024-07-29T15:51:28.071Z",
            "description": "string",
            "id": "string",
            "image_url": "string",
            "name": "string",
            "project": "string",
            "human": "string",
            "gender": "male",
            "tags": [
              {
                "human_name": "string",
                "name": "string"
              }
            ],
            "voice": "string"
          },
          "scenario": {
            "created_at": "2024-07-29T15:51:28.071Z",
            "id": "string",
            "name": "string",
            "project": "string",
            "prompt": "string",
            "human": "string"
          },
          "context": {
            "id": "string",
            "created_at": "2024-07-29T15:51:28.071Z",
            "project": "string",
            "human": "string",
            "latest_messages": [
              {
                "id": "string",
                "speaking_ended_at": "2024-07-29T15:51:28.071Z",
                "speaking_started_at": "2024-07-29T15:51:28.071Z",
                "created_at": "2024-07-29T15:51:28.071Z",
                "role": "assistant",
                "realtime_session": "string",
                "content": [
                  {
                    "type": "text",
                    "text": "string"
                  }
                ],
                "tool_calls": [
                  {
                    "id": "string",
                    "type": "function",
                    "function": {
                      "name": "string",
                      "arguments": {}
                    }
                  }
                ]
              }
            ]
          },
          "tool_definitions": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "parameters": [
                {
                  "name": "string",
                  "description": "string",
                  "type": "string",
                  "required": true,
                  "default": "string"
                }
              ],
              "call_settings": {
                "id": "string",
                "destination": {
                  "type": "web_request",
                  "url": "string"
                }
              }
            }
          ],
          "_extra": {}
        },
        "output": {
          "stream_transcript": true,
          "speech_synthesis_enabled": true,
          "answer_message": "string"
        }
      },
      "data": [
        {
          "type": "caller_phone_number",
          "value": "string"
        }
      ],
      "_extra": {}
    }
  ]
}

400

Bad request

application/json

Schema

Schema

typestring

The type of the error.

Possible values: [usage_limit_exceeded, project_disabled, moderation_error, invalid_input]

messagestring

A human-readable message describing the error.

Example (auto)

{
  "type": "usage_limit_exceeded",
  "message": "string"
}

500

Internal server error

application/json

Schema

Schema

errorstring

Error message.

Example (auto)

{
  "error": "string"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gabber.dev/v1/realtime/list");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.gabber.dev

Auth

Security Scheme

ApiKeyAuthBearerAuth

ApiKeyAuth

Parameters

page — query

x-human-id — header

ResponseClear

Click the Send API Request button above and see the response here!