Get Database Connection

Get Db

curl --request GET \
  --url https://api.xpander.ai/v1/misc/db \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.xpander.ai/v1/misc/db', 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.xpander.ai/v1/misc/db",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.xpander.ai/v1/misc/db"

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

	req.Header.Add("x-api-key", "<api-key>")

	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://api.xpander.ai/v1/misc/db")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "quiet-meadow-12345678",
  "name": "org_0a0a0a0a-1b1b-2c2c-3d3d-4e4e4e4e4e4e",
  "organization_id": "0a0a0a0a-1b1b-2c2c-3d3d-4e4e4e4e4e4e",
  "connection_uri": {
    "uri": "postgresql://xpander:<password>@ep-example-12345.c-2.us-west-2.aws.neon.tech/xpander?channel_binding=require&sslmode=require"
  }
}

GET

misc

Get Db

curl --request GET \
  --url https://api.xpander.ai/v1/misc/db \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.xpander.ai/v1/misc/db', 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.xpander.ai/v1/misc/db",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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.xpander.ai/v1/misc/db"

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

	req.Header.Add("x-api-key", "<api-key>")

	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://api.xpander.ai/v1/misc/db")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "quiet-meadow-12345678",
  "name": "org_0a0a0a0a-1b1b-2c2c-3d3d-4e4e4e4e4e4e",
  "organization_id": "0a0a0a0a-1b1b-2c2c-3d3d-4e4e4e4e4e4e",
  "connection_uri": {
    "uri": "postgresql://xpander:<password>@ep-example-12345.c-2.us-west-2.aws.neon.tech/xpander?channel_binding=require&sslmode=require"
  }
}

Retrieve the PostgreSQL database connection details for your organization. This provides direct access to your organization’s database instance for custom analytics, integrations, and data management.

Response

string

Database project identifier

string

Database project name (typically org_[organization_id])

string

Your organization UUID

object

Database connection details

Show Connection URI Object

string

Complete PostgreSQL connection string with credentialsFormat: postgresql://<user>:<password>@<host>/<database>?<params>

Example Request

curl -X GET -H "x-api-key: <your-api-key>" \
  https://api.xpander.ai/v1/misc/db

Example Response

{
  "id": "still-meadow-47437464",
  "name": "org_f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "organization_id": "<org-id>",
  "connection_uri": {
    "uri": "postgresql://<user>:<password>@<host>/<database>?sslmode=require"
  }
}

Usage Examples

Python (psycopg2)

import psycopg2
import requests

# Get connection string
response = requests.get(
    "https://api.xpander.ai/v1/misc/db",
    headers={"x-api-key": "<your-api-key>"}
)
connection_uri = response.json()["connection_uri"]["uri"]

# Connect to database
conn = psycopg2.connect(connection_uri)
cursor = conn.cursor()

# Query data
cursor.execute("SELECT * FROM agents LIMIT 10")
results = cursor.fetchall()

cursor.close()
conn.close()

Node.js (pg)

const fetch = require('node-fetch');
const { Client } = require('pg');

// Get connection string
const response = await fetch('https://api.xpander.ai/v1/misc/db', {
  headers: { 'x-api-key': '<your-api-key>' }
});
const { connection_uri } = await response.json();

// Connect to database
const client = new Client({
  connectionString: connection_uri.uri
});
await client.connect();

// Query data
const result = await client.query('SELECT * FROM agents LIMIT 10');
console.log(result.rows);

await client.end();

CLI (psql)

# Get connection string and connect
psql "$(curl -s -H 'x-api-key: <your-api-key>' \
  https://api.xpander.ai/v1/misc/db | jq -r '.connection_uri.uri')"

Database Schema

Your organization database contains tables for:

agents - Agent configurations and metadata
tasks - Task execution records
knowledge_bases - Knowledge base metadata
documents - Document records and processing status
users - User information and permissions
organization - Organization settings and data
And more…

Security Notes

The connection string includes credentials - keep it secure
Store the connection string as an environment variable, never in version control
Use HTTPS only when retrieving connection strings
The database requires SSL connections (sslmode=require)
Be cautious with write operations to avoid accidental data modification
Regularly rotate credentials in your organization settings

Use Cases

Custom analytics - Query task and agent data directly for reporting
Data export - Extract data for external analysis and backup
Business intelligence - Connect BI tools like Tableau, Metabase, Power BI
Integration - Build custom integrations with third-party systems
Automation - Create automated data processing pipelines
Advanced queries - Perform complex SQL queries not available via REST API

Notes

This is a Neon PostgreSQL serverless database
Connection pooling is handled automatically
Database is located in AWS us-west-2 region
SSL connections are required for security
Connection credentials are organization-specific and should not be shared

Authorizations

x-api-key

string

header

required

API Key for authentication

Response

200 - application/json

Successful Response

Represents a Neon project used in xpander.ai for managing database resources.

Attributes: id (str): Unique identifier for the Neon project. name (str): Name of the Neon project. organization_id (Optional[str]): The associated organization ID, inferred from the name if not provided. connection_uri (Optional[ConnectionURIResponse]): The connection URI for the project.

string

required

name

string

required

organization_id

string | null

connection_uri

ConnectionURIResponse · object | null

Show child attributes

Execute Custom Function

List LLM Providers

⌘I

Overview

REST API - Agents

REST API - Scheduled Tasks

REST API - Self-Schedules

Agent Workspace

REST API - Agent Gateway

REST API - Tasks

REST API - Knowledge

REST API - Workflows

REST API - Tools

REST API - Custom Functions

REST API - Misc

Get Database Connection

Response

Example Request

Example Response

Usage Examples

Python (psycopg2)

Node.js (pg)

CLI (psql)

Database Schema

Security Notes

Use Cases

Notes

Authorizations

Response

​Response

​Example Request

​Example Response

​Usage Examples

​Python (psycopg2)

​Node.js (pg)

​CLI (psql)

​Database Schema

​Security Notes

​Use Cases

​Notes

Authorizations

Response

Response

Example Request

Example Response

Usage Examples

Python (psycopg2)

Node.js (pg)

CLI (psql)

Database Schema

Security Notes

Use Cases

Notes