Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tryvox.co/llms.txt

Use this file to discover all available pages before exploring further.

vox.ai v3 API는 음성 AI 에이전트의 전체 라이프사이클을 코드로 제어할 수 있는 REST API입니다. v2 대비 일관된 컨벤션, 명시적인 에러 모델, 그리고 스키마 레지스트리를 통한 자기 기술적인(self-describing) 계약을 제공합니다.

​
Base URL

https://client-api.tryvox.co/v3

​
인증

모든 요청에는 Authorization: Bearer <token> 헤더가 필요합니다. 토큰은 대시보드 설정에서 발급한 조직 API 키를 사용합니다. 
curl https://client-api.tryvox.co/v3/agents \
  -H "Authorization: Bearer $VOX_API_KEY"

​
컨벤션

  • snake_case — 요청·응답 필드는 기본적으로 snake_case를 사용합니다. 예외적으로 agent.data와 flow_data 하위는 에이전트 레지스트리와 플로우 빌더 호환을 위해 callSettings, toolIds, builtInTools, sourceHandle 등 camelCase를 유지합니다.
  • 밀리초 타임스탬프 — _at 으로 끝나는 타임스탬프 필드는 unix milliseconds입니다.
  • 커서 페이지네이션 — list 엔드포인트는 cursor / limit(1–100)을 사용합니다. 다음 페이지는 응답의 next_cursor를 그대로 다시 전달합니다.
  • 명시적 식별자 — 응답 객체 자신의 id는 id를 사용합니다. 다른 리소스 참조는 agent_id, call_id처럼 명시적인 이름을 사용합니다.
  • 에러 엔벨로프 — 모든 실패 응답은 { "error": { "code", "message", "details" } } 형태입니다. 제어 흐름은 code 를 기준으로 분기합니다.

​
주요 리소스

에이전트

음성 에이전트(single prompt / flow)와 버전을 생성·수정·게시합니다.

통화 · 캠페인

아웃바운드 단건 콜과 대량 캠페인을 실행·조회합니다.

전화번호

번호 구매·등록, 에이전트 매핑, SIP 트렁크를 관리합니다.

도구

커스텀 도구 정의와 빌트인 도구 카탈로그를 다룹니다.

스키마

agent.data / flow_data / 빌트인 도구 입력 스키마를 런타임에서 조회합니다.

알림 · 모니터링

알림 룰과 인시던트, 통화 데이터를 추적합니다.

​
스키마 레지스트리

v3는 에이전트 작성에 필요한 모든 JSON Schema를 API로 노출합니다. 클라이언트(특히 코드 생성 에이전트)는 스키마를 하드코딩하지 않고 런타임에서 조회해 사용할 수 있습니다.
  • GET /schemas — 사용 가능한 스키마 목록을 조회합니다(agent-schema, flow-schema, tool-schema 등).
  • GET /schemas/{namespace}/{schema_type} — 특정 스키마 본문을 조회합니다.
  • GET /schemas?category=agent-authoring&include_schema=true — 에이전트 작성에 필요한 스키마(agent.data, flow_data)를 함께 조회합니다.

​
관련 문서

  • 단건 발신 — API로 단건 아웃바운드 통화를 실행하는 방법을 설명합니다.
  • 대량 발신 — CSV/Excel로 대량 아웃바운드 캠페인을 실행하는 방법을 설명합니다.
  • v2 API 참조 — 기존 통합을 사용 중이면 참고할 수 있습니다.
v3 API, REST API, API 레퍼런스, API reference, 인증, authentication, API Key, endpoint, 스키마 레지스트리, schema registry, OpenAPI