{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ultravox accounts agents API",
    "version": "0.1.0"
  },
  "items": [
    {
      "info": {
        "name": "agents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "agents_list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ultravox.ai/api/agents",
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor value."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "The search string used to filter results"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Which field to use when ordering the results."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ultravox.ai/api/agents",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ultravox.ai/api/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_partial_update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.ultravox.ai/api/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_destroy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.ultravox.ai/api/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_calls_list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/calls",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor value."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_calls_create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/calls",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "throttle",
                "value": "",
                "type": "query",
                "description": "The name or ID of a call throttle to apply to this call. If the throttle's rate limits have been exceeded, the call will be rejected with a 429 status."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_scheduled_batches_list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/scheduled_batches",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor value."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_scheduled_batches_create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/scheduled_batches",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_scheduled_batches_retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/scheduled_batches/:batch_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "batch_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_scheduled_batches_partial_update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/scheduled_batches/:batch_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "batch_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_scheduled_batches_destroy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/scheduled_batches/:batch_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "batch_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_scheduled_batches_created_calls_list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/scheduled_batches/:batch_id/created_calls",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "batch_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor value."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "agents_scheduled_batches_scheduled_calls_list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/scheduled_batches/:batch_id/scheduled_calls",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "batch_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor value."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "* `FUTURE` - FUTURE\n* `PENDING` - PENDING\n* `SUCCESS` - SUCCESS\n* `EXPIRED` - EXPIRED\n* `ERROR` - ERROR"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "List scheduled calls within a batch."
        },
        {
          "info": {
            "name": "agents_telephony_xml",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ultravox.ai/api/agents/:agent_id/telephony_xml",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows supported telephony providers to create incoming calls with an agent, returning XML instructions for handling the call."
        },
        {
          "info": {
            "name": "agents_usage_list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ultravox.ai/api/agents/usage",
            "params": [
              {
                "name": "agentIds",
                "value": "",
                "type": "query",
                "description": "Filter calls by the agent IDs."
              },
              {
                "name": "durationMax",
                "value": "",
                "type": "query",
                "description": "Maximum duration of calls"
              },
              {
                "name": "durationMin",
                "value": "",
                "type": "query",
                "description": "Minimum duration of calls"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query",
                "description": "Start datetime (inclusive) for filtering calls by creation date. If no time component is present, this defaults to the start of the day (midnight)."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "Filter calls by metadata. Use metadata.key=value to filter by specific key-value pairs."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "The search string used to filter results"
              },
              {
                "name": "timeOfDayEnd",
                "value": "",
                "type": "query",
                "description": "Filter calls by the time of day of their creation, regardless of date. Format: HH:MM:SS. Defaults to 23:59:59 if not specified."
              },
              {
                "name": "timeOfDayStart",
                "value": "",
                "type": "query",
                "description": "Filter calls by the time of day of their creation, regardless of date. Format: HH:MM:SS. Defaults to 00:00:00 if not specified."
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query",
                "description": "End datetime (inclusive) for filtering calls by creation date. If no time component is present, this defaults to the end of the day (11:59:59.999999 PM)."
              },
              {
                "name": "voiceId",
                "value": "",
                "type": "query",
                "description": "Filter calls by the associated voice ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          }
        }
      ]
    }
  ],
  "bundled": true
}