Skip to main content

Samaritan home page

GitHub
Open Repository
Open Repository

GitHub

API Reference

GET
Root
GET
Health Check

apps

GET
List Apps Endpoint
POST
Import Apps Endpoint
DEL
Delete App Endpoint
PATCH
Update App Endpoint
POST
Enrich App Endpoint

brand-studio

GET
List Assets Endpoint
POST
Upload Asset Endpoint
GET
Get Asset Endpoint
DEL
Delete Asset Endpoint
PATCH
Update Asset Endpoint
GET
Serve Asset File
GET
List Collections Endpoint
POST
Create Collection Endpoint
GET
Get Collection Endpoint
DEL
Delete Collection Endpoint
PATCH
Update Collection Endpoint
POST
Add Garment Endpoint
PUT
Reorder Garments Endpoint
POST
Share Collection Endpoint
DEL
Revoke Collection Share Endpoint
DEL
Delete Garment Endpoint
PATCH
Update Garment Endpoint
POST
Share Garment Endpoint
GET
Resolve Share Endpoint

cantonese

GET
Dashboard
GET
Lessons
POST
Review Start
POST
Review Complete
POST
Review Submit
GET
Vocab List
GET
Word Detail

career

GET
Career Coaches
GET
Career Composites
GET
Career Goal Get
PUT
Career Goal Set
POST
Confirm Job
POST
Extract Job
GET
Career Overview
GET
Career Patterns
GET
Recommend Jobs
POST
Feedback Recommendation Job
POST
Feedback Recommendation Jobs Batch
GET
Recommendation Feedback Stats
POST
Recommendation Impression
GET
Career Skill Provenance
GET
Career Taxonomy
GET
Career Taxonomy Inventory

changelog

GET
Get Changelog

chat

POST
Chat Endpoint
POST
Chat Stream Endpoint

chinese

GET
Dashboard
GET
Lessons
POST
Review Start
POST
Review Complete
POST
Review Submit
GET
Vocab List
GET
Word Detail

conversations

GET
Get Conversations
POST
Bulk Delete Conversations Endpoint
GET
Get Conversation By Id
DEL
Delete Conversation By Id
PATCH
Update Conversation

courses

GET
List Courses

evals

GET
Compare Eval Runs
GET
Get Golden Dataset
GET
List Eval Runs
GET
Get Eval Run

events

GET
List Events Endpoint
POST
Create Event Endpoint
DEL
Delete Event Endpoint
PATCH
Update Event Endpoint

feedback

POST
Submit Feedback
GET
Get Review Queue
GET
Get Stats

hf-projects

GET
Discover Endpoint
GET
List Saved Endpoint
POST
Save Endpoint
DEL
Unsave Endpoint
GET
Search Endpoint

ingest

POST
Start Ingestion
GET
Get Activity Feed
POST
Detect Content
POST
Preview Pattern Impact Endpoint
GET
Get Ingest Stats
POST
Upload File
POST
Ingest Url
GET
Get Job Status
GET
Get Pattern Preview For Job
GET
Get Ingest Trace

learnings

GET
List Learnings Endpoint

library

GET
List Sources
GET
Get Source
DEL
Delete Source
GET
Get Source Chunks
GET
Get Source Connections
POST
Reingest Source

module48

GET
Get Operations Endpoint
PUT
Upsert Operations Endpoint
GET
List Pnl Endpoint
POST
Create Pnl Endpoint
DEL
Delete Pnl Endpoint
PATCH
Update Pnl Endpoint

namespaces

GET
List Namespaces Endpoint
GET
Get Namespace Stats Endpoint

network-ops

POST
Create Linkedin Snapshot Endpoint
GET
Get Linkedin Summary Endpoint

opportunities

GET
List Opportunities Endpoint
POST
Create Opportunity Endpoint
GET
Get Opportunity Endpoint
DEL
Delete Opportunity Endpoint
PATCH
Update Opportunity Endpoint
POST
Prep Opportunity Endpoint

oss-projects

GET
Discover Endpoint
GET
List Saved Endpoint
POST
Save Endpoint
DEL
Unsave Endpoint
GET
Search Endpoint

personal

GET
List Dump Endpoint
POST
Create Dump Endpoint
POST
Bulk Create Dump Endpoint
DEL
Delete Dump Endpoint
PATCH
Update Dump Endpoint
GET
List Equipment Endpoint
POST
Create Equipment Endpoint
POST
Bulk Create Equipment Endpoint
DEL
Delete Equipment Endpoint
PATCH
Update Equipment Endpoint
GET
List Renewals Endpoint
POST
Create Renewal Endpoint
POST
Bulk Create Renewals Endpoint
DEL
Delete Renewal Endpoint
PATCH
Update Renewal Endpoint
GET
List Trips Endpoint
POST
Create Trip Endpoint
POST
Bulk Create Trips Endpoint
DEL
Delete Trip Endpoint
PATCH
Update Trip Endpoint
GET
List Web Gallery Endpoint
POST
Create Web Gallery Endpoint
POST
Bulk Create Web Gallery Endpoint
DEL
Delete Web Gallery Endpoint
PATCH
Update Web Gallery Endpoint

projects

GET
Get Projects
POST
Create New Project
POST
Extract From Source
POST
Generate Ideas
POST
Save Idea
GET
Get Project By Id
DEL
Delete Project By Id
PATCH
Update Project By Id
GET
Get Evidence Chunk
GET
List Project Files
POST
Upload Project Files
GET
Get Project File

reference-tracks

GET
List Tracks Endpoint
POST
Create Track Endpoint
GET
Get Track Endpoint
DEL
Delete Track Endpoint
PATCH
Update Track Endpoint

search

GET
Search Knowledge Base

social

GET
Get Social Connections
POST
Publish Social Post
GET
Social Oauth Callback
GET
Connect Social Platform
DEL
Disconnect Social Platform

sonic

GET
Blind Spots
GET
Influences
GET
Overview
GET
Profile

source-assets

GET
Get Source Assets
GET
Serve Source Asset

startup-challenges

GET
List Challenges Endpoint
POST
Create Challenge Endpoint
POST
Generate Challenge Endpoint
GET
Get Challenge Endpoint
DEL
Delete Challenge Endpoint
PATCH
Update Challenge Endpoint
POST
Add Step Endpoint
PUT
Reorder Steps Endpoint
DEL
Delete Step Endpoint
PATCH
Update Step Endpoint

stats

GET
Get Llm Calls
GET
Get Cost Stats
GET
Plan Usage
GET
Get Provider Health
GET
Get Slo

user-skills

GET
List User Skills
PUT
Replace User Skills
POST
Add Skill
DEL
Delete Skill

vault

GET
Get Vault Stats

youtube

GET
Get Youtube Info

Root

Copy

curl --request GET \
  --url https://api.example.com/

API Reference

Root

GET

Root

Copy

curl --request GET \
  --url https://api.example.com/

Response

200 - application/json

Successful Response

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform