Skip to main content
GET
/
api
/
v1
/
endpoints
curl --request GET \
  --url http://localhost:8080/api/v1/endpoints/ \
  --header 'Authorization: Bearer YOUR_TOKEN'

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Legal Q&A Endpoint",
    "slug": "legal-qa",
    "summary": "Legal document Q&A system",
    "response_type": "both",
    "published": true,
    "tags": "legal,qa,documents",
    "created_at": "2024-03-01T12:00:00Z",
    "model": {
      "id": "223e4567-e89b-12d3-a456-426614174000",
      "name": "GPT-4 Legal",
      "dtype": "openai",
      "configuration": {
        "model_name": "gpt-4",
        "api_key": "***"
      }
    },
    "dataset": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Legal Documents DB",
      "summary": "Vector database of legal documents",
      "dtype": "weaviate",
      "configuration": {
        "host": "localhost",
        "port": 8080
      }
    }
  },
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "name": "Medical Research Assistant",
    "slug": "medical-research",
    "summary": "Search medical research papers",
    "response_type": "raw",
    "published": false,
    "tags": "medical,research,papers",
    "created_at": "2024-03-02T10:30:00Z",
    "model": null,
    "dataset": {
      "id": "333e4567-e89b-12d3-a456-426614174002",
      "name": "PubMed Database",
      "summary": "Medical research papers",
      "dtype": "weaviate",
      "configuration": {
        "host": "localhost",
        "port": 8081
      }
    }
  }
]
Retrieve a list of all endpoints in your tenant with summary information.

​
Authentication

Requires tenant authentication via SyftBox token.

​
Response

Returns an array of endpoint objects with summary information.
​
id
string
required
Unique identifier for the endpoint.
​
name
string
required
Name of the endpoint.
​
slug
string
required
URL-friendly unique identifier.
​
summary
string
required
Brief description of the endpoint.
​
response_type
string
required
Type of response (raw/summary/both).
​
published
boolean
required
Whether the endpoint is published.
​
tags
string
required
Comma-separated tags.
​
created_at
string
required
ISO 8601 timestamp of when the endpoint was created.
​
model
object
Attached model information, if any.
​
dataset
object
Attached dataset information, if any.
curl --request GET \
  --url http://localhost:8080/api/v1/endpoints/ \
  --header 'Authorization: Bearer YOUR_TOKEN'

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Legal Q&A Endpoint",
    "slug": "legal-qa",
    "summary": "Legal document Q&A system",
    "response_type": "both",
    "published": true,
    "tags": "legal,qa,documents",
    "created_at": "2024-03-01T12:00:00Z",
    "model": {
      "id": "223e4567-e89b-12d3-a456-426614174000",
      "name": "GPT-4 Legal",
      "dtype": "openai",
      "configuration": {
        "model_name": "gpt-4",
        "api_key": "***"
      }
    },
    "dataset": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Legal Documents DB",
      "summary": "Vector database of legal documents",
      "dtype": "weaviate",
      "configuration": {
        "host": "localhost",
        "port": 8080
      }
    }
  },
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "name": "Medical Research Assistant",
    "slug": "medical-research",
    "summary": "Search medical research papers",
    "response_type": "raw",
    "published": false,
    "tags": "medical,research,papers",
    "created_at": "2024-03-02T10:30:00Z",
    "model": null,
    "dataset": {
      "id": "333e4567-e89b-12d3-a456-426614174002",
      "name": "PubMed Database",
      "summary": "Medical research papers",
      "dtype": "weaviate",
      "configuration": {
        "host": "localhost",
        "port": 8081
      }
    }
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us