Skip to main content
GET
/
assistants
/
{assistant_id}
/
schemas
Get Assistant Schemas
curl --request GET \
  --url https://api.example.com/assistants/{assistant_id}/schemas
import requests

url = "https://api.example.com/assistants/{assistant_id}/schemas"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/assistants/{assistant_id}/schemas', 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://api.example.com/assistants/{assistant_id}/schemas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/assistants/{assistant_id}/schemas"

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

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/assistants/{assistant_id}/schemas")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/assistants/{assistant_id}/schemas")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "graph_id": "<string>",
  "state_schema": {},
  "input_schema": {},
  "output_schema": {},
  "config_schema": {},
  "context_schema": {}
}
{
  "detail": "<string>"
}
{
  "detail": "<string>"
}

Path Parameters

assistant_id
string<uuid>
required

The ID of the assistant.

Response

Success

Defines the structure and properties of a graph.

graph_id
string
required

The ID of the graph.

state_schema
State Schema · object
required

The schema for the graph state. Missing if unable to generate JSON schema from graph.

input_schema
Input Schema · object

The schema for the graph input. Missing if unable to generate JSON schema from graph.

output_schema
Output Schema · object

The schema for the graph output. Missing if unable to generate JSON schema from graph.

config_schema
Config Schema · object

The schema for the graph config. Missing if unable to generate JSON schema from graph.

context_schema
Context Schema · object

The schema for the graph context. Missing if unable to generate JSON schema from graph.