Skip to main content

API reference

Members API
Direct link to Members API

The root URL for the endpoints below is: /v1/org/members

MethodEndpointDescription
GET/List members
POST/invitationsSend an invitation
GET/invitationsList invitations
DELETE/invitations/:idRevoke an invitation
PATCH/:idUpdate member role
DELETE/:idRemove a member

API tokens
Direct link to API tokens

The root URL for the endpoints below is: /v1/auth/tokens

MethodEndpointDescription
POST/Create an API token
GET/List API tokens
DELETE/:idDelete an API token

Studio API
Direct link to Studio API

The root URL for the endpoints below is: /v1/studio

MethodEndpointDescription
GET/projectsList studio projects
POST/projectsCreate a project
GET/projects/:idGet project detail and deploys
DELETE/projects/:idDelete a project
POST/deploysCreate a deploy
POST/deploys/:id/upload-completeConfirm artifact upload
GET/deploys/:idGet deploy status
GET/deploys/:id/logsGet deploy logs
GET/deploys/:id/logs/streamStream deploy logs (SSE)

Server API
Direct link to Server API

The root URL for the endpoints below is: /v1/server

MethodEndpointDescription
GET/projectsList server projects
POST/projectsCreate a project
GET/projects/:idGet project detail
DELETE/projects/:idDelete a project
PUT/projects/:id/envSet environment variables
GET/projects/:id/envGet environment variables
POST/projects/:id/env/restartRestart after env change
GET/projects/:id/domainsList domains
POST/projects/:id/domainsAdd a custom domain
GET/projects/:id/runtime-logsGet runtime logs
POST/projects/:id/redeployTrigger redeploy
POST/projects/:id/always-onEnable always-on
DELETE/projects/:id/always-onDisable always-on
POST/deploysCreate a deploy
POST/deploys/:id/upload-completeConfirm artifact upload
GET/deploys/:idGet deploy status
GET/deploys/:id/logsGet deploy logs
POST/deploys/:id/cancelCancel a queued or in-progress deploy
DELETE/deploys/:idStop a running deploy

Gateway API
Direct link to Gateway API

The root URL for the endpoints below is: /v1/gateway

MethodEndpointDescription
GET/projectsList gateway projects
GET/projects/:idGet project detail
PATCH/projects/:idUpdate project settings
DELETE/projects/:idDelete a project
POST/projects/provisionProvision a new gateway project
GET/projects/:id/keysList API keys
POST/projects/:id/keysCreate an API key
DELETE/projects/:id/keys/:keyIdRevoke an API key
GET/projects/:id/keys/:keyId/bindingsList key-level provider bindings
POST/projects/:id/keys/:keyId/bindingsAdd a key-level provider binding (BYOK)
DELETE/projects/:id/keys/:keyId/bindings/:providerRemove a key-level binding
GET/projects/:id/bindingsList project-level provider bindings
POST/projects/:id/bindingsAdd a project-level provider binding (BYOK)
DELETE/projects/:id/bindings/:providerRemove a project-level binding
GET/projects/:id/usage/has-activityCheck whether project has any requests
GET/projects/:id/usage/activityGet aggregated usage activity
GET/projects/:id/usage/memory-activityGet memory-token totals over a time range
GET/projects/:id/usage/logsGet request logs
GET/projects/:id/usage/logs/facetsGet log filter facets
GET/projects/:id/usage/logs/:requestIdGet specific request detail
GET/projects/:id/memory/threadsList threads (dashboard)
POST/projects/:id/memory/threadsCreate a thread (dashboard)
GET/projects/:id/memory/threads/:threadIdGet thread (dashboard)
PATCH/projects/:id/memory/threads/:threadIdUpdate thread (dashboard)
DELETE/projects/:id/memory/threads/:threadIdDelete thread (dashboard)
POST/projects/:id/memory/threads/:threadId/cloneClone thread (dashboard)
GET/projects/:id/memory/threads/:threadId/messagesList messages (dashboard)
POST/projects/:id/memory/threads/:threadId/messagesSave messages (dashboard)
DELETE/projects/:id/memory/threads/:threadId/messagesDelete messages (dashboard)
GET/projects/:id/memory/threads/:threadId/observations/historyObservation history (dashboard)
GET/modelsList available models

Gateway proxy endpoints
Direct link to Gateway proxy endpoints

Visit the Memory Gateway documentation for more details.

On this page