Get knowledge base schema

curl --request GET \
  --url https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "concern": "<string>",
  "schema_version": "<string>",
  "shape": "blocks",
  "revision": "<string>",
  "blocks": [
    {
      "id": "<string>",
      "label": "<string>",
      "label_key": "<string>",
      "fields": [
        "<string>"
      ]
    }
  ],
  "fields": [
    {
      "key": "<string>",
      "block": "<string>",
      "name": "<string>",
      "component": "<string>",
      "value_type": "string",
      "label": "<string>",
      "write": {},
      "validation": {},
      "dependencies": [
        {}
      ],
      "capabilities": {
        "visible": true,
        "writable": true,
        "disabled": true,
        "reason": "<string>",
        "reason_key": "<string>"
      },
      "label_key": "<string>",
      "description_key": "<string>",
      "placeholder_key": "<string>",
      "options_ref": "<string>",
      "affects_schema": true
    }
  ],
  "option_sets": {}
}

GET

api

voice_agents

{id}

concerns

knowledge_base

schema

Get knowledge base schema

curl --request GET \
  --url https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.miyon.ai/api/v1/voice_agents/{id}/concerns/knowledge_base/schema")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "concern": "<string>",
  "schema_version": "<string>",
  "shape": "blocks",
  "revision": "<string>",
  "blocks": [
    {
      "id": "<string>",
      "label": "<string>",
      "label_key": "<string>",
      "fields": [
        "<string>"
      ]
    }
  ],
  "fields": [
    {
      "key": "<string>",
      "block": "<string>",
      "name": "<string>",
      "component": "<string>",
      "value_type": "string",
      "label": "<string>",
      "write": {},
      "validation": {},
      "dependencies": [
        {}
      ],
      "capabilities": {
        "visible": true,
        "writable": true,
        "disabled": true,
        "reason": "<string>",
        "reason_key": "<string>"
      },
      "label_key": "<string>",
      "description_key": "<string>",
      "placeholder_key": "<string>",
      "options_ref": "<string>",
      "affects_schema": true
    }
  ],
  "option_sets": {}
}

Autorisierungen

Authorization

string

header

erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Pfadparameter

integer

erforderlich

ID of the voice agent.

Antwort

option_sets["knowledge_base.datasources"] lists the knowledge sources of your account.

Fields, their accepted values and display groups of a settings group, for this agent's current configuration.

concern

string

erforderlich

The settings group this schema describes.

schema_version

string

erforderlich

Version of the settings schema.

shape

string

erforderlich

Layout hint for clients that render the settings; always blocks.

Allowed value: "blocks"

revision

string

erforderlich

Revision of the schema. Changes when the available fields or options change.

blocks

object[]

erforderlich

Display groups, each listing the keys of the fields it contains.

Show child attributes

fields

object[]

erforderlich

Every setting of the group with its type, constraints and current capabilities.

Show child attributes

option_sets

object

erforderlich

Accepted values for selection fields, keyed by the field's options_ref.

Show child attributes

Get started

Voice Agents

Voice Agent Settings

Tools

Outbound Calls

Conversations

Evals

Get knowledge base schema

Autorisierungen

Pfadparameter

Antwort