Services Reference

Complete list of all SDK service classes and their methods, grouped by module. Each method corresponds to one REST endpoint.

actors

See actors module docs for permissions and data model.

Method	HTTP	Path	Description
actors.listActors()	GET	/api/v1/api/v1/actors	List actors
actors.createActor()	POST	/api/v1/api/v1/actors	Create an actor
actors.getActor()	GET	/api/v1/api/v1/actors/{actor_id}	Get an actor by ID
actors.deleteActor()	DELETE	/api/v1/api/v1/actors/{actor_id}	Delete an actor
actors.updateActor()	PATCH	/api/v1/api/v1/actors/{actor_id}	Update an actor
actors.getActorTags()	GET	/api/v1/api/v1/actors/{actor_id}/tags	Get actor tags
actors.replaceActorTags()	PUT	/api/v1/api/v1/actors/{actor_id}/tags	Replace actor tags
actors.mergeActorTags()	PATCH	/api/v1/api/v1/actors/{actor_id}/tags	Merge actor tags

agentFormations

See agentFormations module docs for permissions and data model.

Method	HTTP	Path	Description
agentFormations.validateAgentFormation()	POST	/api/v1/api/v1/agent-formations/validate	Validate a formation template
agentFormations.planAgentFormation()	POST	/api/v1/api/v1/agent-formations/plan	Plan a formation deployment
agentFormations.listAgentFormations()	GET	/api/v1/api/v1/agent-formations	List agent formations
agentFormations.createAgentFormation()	POST	/api/v1/api/v1/agent-formations	Create a new agent formation
agentFormations.getAgentFormation()	GET	/api/v1/api/v1/agent-formations/{formation_id}	Get a specific agent formation
agentFormations.updateAgentFormation()	PUT	/api/v1/api/v1/agent-formations/{formation_id}	Update an agent formation
agentFormations.deleteAgentFormation()	DELETE	/api/v1/api/v1/agent-formations/{formation_id}	Delete an agent formation
agentFormations.listAgentFormationEvents()	GET	/api/v1/api/v1/agent-formations/{formation_id}/events	List formation operation events

agents

See agents module docs for permissions and data model.

Method	HTTP	Path	Description
agents.createAgentTool()	POST	/api/v1/api/v1/agents/tools	Create an agent tool
agents.listAgentTools()	GET	/api/v1/api/v1/agents/tools	List agent tools
agents.getAgentTool()	GET	/api/v1/api/v1/agents/tools/{tool_id}	Get an agent tool
agents.updateAgentTool()	PUT	/api/v1/api/v1/agents/tools/{tool_id}	Update an agent tool
agents.deleteAgentTool()	DELETE	/api/v1/api/v1/agents/tools/{tool_id}	Delete an agent tool
agents.createAgent()	POST	/api/v1/api/v1/agents	Create an agent
agents.listAgents()	GET	/api/v1/api/v1/agents	List agents
agents.getAgent()	GET	/api/v1/api/v1/agents/{agent_id}	Get an agent
agents.updateAgent()	PUT	/api/v1/api/v1/agents/{agent_id}	Update an agent
agents.deleteAgent()	DELETE	/api/v1/api/v1/agents/{agent_id}	Delete an agent
agents.createAgentGeneration()	POST	/api/v1/api/v1/agents/{agent_id}/generate	Run an agent generation
agents.submitAgentToolOutputs()	POST	/api/v1/api/v1/agents/{agent_id}/generate/{generation_id}/tool-outputs	Submit tool outputs for a paused generation
agents.createAgentActor()	POST	/api/v1/api/v1/agents/{agent_id}/actors	Create an actor for an agent

aiProviders

See aiProviders module docs for permissions and data model.

Method	HTTP	Path	Description
aiProviders.listAiProviders()	GET	/api/v1/api/v1/ai-providers	List AI providers
aiProviders.createAiProvider()	POST	/api/v1/api/v1/ai-providers	Create an AI provider
aiProviders.getAiProvider()	GET	/api/v1/api/v1/ai-providers/{ai_provider_id}	Get an AI provider
aiProviders.updateAiProvider()	PATCH	/api/v1/api/v1/ai-providers/{ai_provider_id}	Update an AI provider
aiProviders.deleteAiProvider()	DELETE	/api/v1/api/v1/ai-providers/{ai_provider_id}	Delete an AI provider

apiKeys

See apiKeys module docs for permissions and data model.

Method	HTTP	Path	Description
apiKeys.listApiKeys()	GET	/api/v1/api/v1/api-keys	List API keys
apiKeys.createApiKey()	POST	/api/v1/api/v1/api-keys	Create an API key
apiKeys.getApiKey()	GET	/api/v1/api/v1/api-keys/{api_key_id}	Get an API key
apiKeys.updateApiKey()	PUT	/api/v1/api/v1/api-keys/{api_key_id}	Update an API key
apiKeys.deleteApiKey()	DELETE	/api/v1/api/v1/api-keys/{api_key_id}	Delete an API key

chats

See chats module docs for permissions and data model.

Method	HTTP	Path	Description
chats.createChat()	POST	/api/v1/api/v1/chats	Create a chat
chats.listChats()	GET	/api/v1/api/v1/chats	List chats
chats.getChat()	GET	/api/v1/api/v1/chats/{chat_id}	Get a chat
chats.deleteChat()	DELETE	/api/v1/api/v1/chats/{chat_id}	Delete a chat
chats.createChatCompletionForChat()	POST	/api/v1/api/v1/chats/{chat_id}/completions	Create a chat completion for a stored chat
chats.createChatCompletion()	POST	/api/v1/api/v1/chats/completions	Create a chat completion (stateless)
chats.createChatActor()	POST	/api/v1/api/v1/chats/{chat_id}/actors	Create an actor for a chat

conversations

See conversations module docs for permissions and data model.

Method	HTTP	Path	Description
conversations.listConversations()	GET	/api/v1/api/v1/conversations	List conversations
conversations.createConversation()	POST	/api/v1/api/v1/conversations	Create a conversation
conversations.getConversation()	GET	/api/v1/api/v1/conversations/{conversation_id}	Get a conversation by ID
conversations.updateConversation()	PATCH	/api/v1/api/v1/conversations/{conversation_id}	Update a conversation
conversations.deleteConversation()	DELETE	/api/v1/api/v1/conversations/{conversation_id}	Delete a conversation
conversations.listConversationMessages()	GET	/api/v1/api/v1/conversations/{conversation_id}/messages	List conversation messages
conversations.addConversationMessage()	POST	/api/v1/api/v1/conversations/{conversation_id}/messages	Add a message to a conversation
conversations.generateConversationMessage()	POST	/api/v1/api/v1/conversations/{conversation_id}/generate	Generate the next message in a conversation
conversations.listConversationActors()	GET	/api/v1/api/v1/conversations/{conversation_id}/actors	List actors in a conversation
conversations.removeConversationMessage()	DELETE	/api/v1/api/v1/conversations/{conversation_id}/messages/{document_id}	Remove a message from a conversation
conversations.getConversationTags()	GET	/api/v1/api/v1/conversations/{conversation_id}/tags	Get conversation tags
conversations.replaceConversationTags()	PUT	/api/v1/api/v1/conversations/{conversation_id}/tags	Replace conversation tags
conversations.mergeConversationTags()	PATCH	/api/v1/api/v1/conversations/{conversation_id}/tags	Merge conversation tags

documents

See documents module docs for permissions and data model.

Method	HTTP	Path	Description
documents.listDocuments()	GET	/api/v1/api/v1/documents	List documents
documents.createDocument()	POST	/api/v1/api/v1/documents	Create a document
documents.getDocument()	GET	/api/v1/api/v1/documents/{document_id}	Get a document by ID
documents.deleteDocument()	DELETE	/api/v1/api/v1/documents/{document_id}	Delete a document
documents.updateDocument()	PATCH	/api/v1/api/v1/documents/{document_id}	Update a document
documents.getDocumentTags()	GET	/api/v1/api/v1/documents/{document_id}/tags	Get document tags
documents.replaceDocumentTags()	PUT	/api/v1/api/v1/documents/{document_id}/tags	Replace document tags
documents.mergeDocumentTags()	PATCH	/api/v1/api/v1/documents/{document_id}/tags	Merge document tags

files

See files module docs for permissions and data model.

Method	HTTP	Path	Description
files.listFiles()	GET	/api/v1/api/v1/files	List all files
files.createFile()	POST	/api/v1/api/v1/files	Create a file
files.uploadFile()	POST	/api/v1/api/v1/files/upload	Upload a file
files.uploadFileBase64()	POST	/api/v1/api/v1/files/upload/base64	Upload a file using base64 encoding
files.getFile()	GET	/api/v1/api/v1/files/{file_id}	Get a file by ID
files.deleteFile()	DELETE	/api/v1/api/v1/files/{file_id}	Delete a file
files.downloadFile()	GET	/api/v1/api/v1/files/{file_id}/download	Download a file
files.updateFileMetadata()	PATCH	/api/v1/api/v1/files/{file_id}/metadata	Update file metadata
files.downloadFileBase64()	GET	/api/v1/api/v1/files/{file_id}/download/base64	Download file as base64
files.getFileTags()	GET	/api/v1/api/v1/files/{file_id}/tags	Get file tags
files.replaceFileTags()	PUT	/api/v1/api/v1/files/{file_id}/tags	Replace file tags
files.mergeFileTags()	PATCH	/api/v1/api/v1/files/{file_id}/tags	Merge file tags

knowledge

See knowledge module docs for permissions and data model.

Method	HTTP	Path	Description
knowledge.searchKnowledge()	POST	/api/v1/api/v1/knowledge/search	Search knowledge

memories

See memories module docs for permissions and data model.

Method	HTTP	Path	Description
memories.listMemories()	GET	/api/v1/api/v1/memories	List memories
memories.createMemory()	POST	/api/v1/api/v1/memories	Create a memory
memories.getMemory()	GET	/api/v1/api/v1/memories/{memory_id}	Get a memory
memories.updateMemory()	PUT	/api/v1/api/v1/memories/{memory_id}	Update a memory
memories.deleteMemory()	DELETE	/api/v1/api/v1/memories/{memory_id}	Delete a memory

memoryEntries

See memoryEntries module docs for permissions and data model.

Method	HTTP	Path	Description
memoryEntries.listMemoryEntries()	GET	/api/v1/api/v1/memories/{memory_id}/entries	List memory entries
memoryEntries.createMemoryEntry()	POST	/api/v1/api/v1/memories/{memory_id}/entries	Create a memory entry
memoryEntries.getMemoryEntry()	GET	/api/v1/api/v1/memories/{memory_id}/entries/{entry_id}	Get a memory entry
memoryEntries.updateMemoryEntry()	PUT	/api/v1/api/v1/memories/{memory_id}/entries/{entry_id}	Update a memory entry
memoryEntries.deleteMemoryEntry()	DELETE	/api/v1/api/v1/memories/{memory_id}/entries/{entry_id}	Delete a memory entry

policies

See policies module docs for permissions and data model.

Method	HTTP	Path	Description
policies.listPolicies()	GET	/api/v1/api/v1/policies	List all policies
policies.createPolicy()	POST	/api/v1/api/v1/policies	Create a policy
policies.getPolicy()	GET	/api/v1/api/v1/policies/{policy_id}	Get a policy
policies.updatePolicy()	PUT	/api/v1/api/v1/policies/{policy_id}	Update a policy
policies.deletePolicy()	DELETE	/api/v1/api/v1/policies/{policy_id}	Delete a policy

projects

See projects module docs for permissions and data model.

Method	HTTP	Path	Description
projects.createProject()	POST	/api/v1/api/v1/projects	Create a project
projects.getProject()	GET	/api/v1/api/v1/projects/{project_id}	Get a project
projects.deleteProject()	DELETE	/api/v1/api/v1/projects/{project_id}	Delete a project

secrets

See secrets module docs for permissions and data model.

Method	HTTP	Path	Description
secrets.listSecrets()	GET	/api/v1/api/v1/secrets	List secrets
secrets.createSecret()	POST	/api/v1/api/v1/secrets	Create a secret
secrets.getSecret()	GET	/api/v1/api/v1/secrets/{secret_id}	Get a secret
secrets.updateSecret()	PATCH	/api/v1/api/v1/secrets/{secret_id}	Update a secret
secrets.deleteSecret()	DELETE	/api/v1/api/v1/secrets/{secret_id}	Delete a secret

sessions

See sessions module docs for permissions and data model.

Method	HTTP	Path	Description
sessions.createAgentSession()	POST	/api/v1/api/v1/agents/{agent_id}/sessions	Create a session
sessions.listAgentSessions()	GET	/api/v1/api/v1/agents/{agent_id}/sessions	List sessions
sessions.getAgentSession()	GET	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}	Get a session
sessions.updateSession()	PATCH	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}	Update a session
sessions.deleteAgentSession()	DELETE	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}	Delete a session
sessions.listAgentSessionMessages()	GET	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}/messages	List session messages
sessions.addSessionMessage()	POST	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}/messages	Add a user message
sessions.generateSessionResponse()	POST	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}/generate	Trigger agent generation
sessions.submitSessionToolOutputs()	POST	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}/tool-outputs	Submit tool outputs
sessions.getSessionTags()	GET	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}/tags	Get session tags
sessions.replaceSessionTags()	PUT	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}/tags	Replace session tags
sessions.mergeSessionTags()	PATCH	/api/v1/api/v1/agents/{agent_id}/sessions/{session_id}/tags	Merge session tags

traces

See traces module docs for permissions and data model.

Method	HTTP	Path	Description
traces.listTraces()	GET	/api/v1/api/v1/traces	List traces
traces.getTrace()	GET	/api/v1/api/v1/traces/{trace_id}	Get a trace
traces.getTraceTree()	GET	/api/v1/api/v1/traces/{trace_id}/tree	Get trace tree

users

See users module docs for permissions and data model.

Method	HTTP	Path	Description
users.listUsers()	GET	/api/v1/api/v1/users	List all users
users.createUser()	POST	/api/v1/api/v1/users	Create a user
users.getUser()	GET	/api/v1/api/v1/users/{user_id}	Get a user by ID
users.deleteUser()	DELETE	/api/v1/api/v1/users/{user_id}	Delete a user by ID
users.bootstrapUser()	POST	/api/v1/api/v1/users/bootstrap	Create the first admin user
users.loginUser()	POST	/api/v1/api/v1/users/login	Login user
users.getUserPolicies()	GET	/api/v1/api/v1/users/{user_id}/policies	Get policies attached to a user
users.attachUserPolicies()	PUT	/api/v1/api/v1/users/{user_id}/policies	Attach policies to a user

webhooks

See webhooks module docs for permissions and data model.

Method	HTTP	Path	Description
webhooks.listWebhooks()	GET	/api/v1/api/v1/projects/{project_id}/webhooks	List webhooks for a project
webhooks.createWebhook()	POST	/api/v1/api/v1/projects/{project_id}/webhooks	Create a webhook
webhooks.getWebhook()	GET	/api/v1/api/v1/projects/{project_id}/webhooks/{webhook_id}	Get a webhook
webhooks.updateWebhook()	PUT	/api/v1/api/v1/projects/{project_id}/webhooks/{webhook_id}	Update a webhook
webhooks.deleteWebhook()	DELETE	/api/v1/api/v1/projects/{project_id}/webhooks/{webhook_id}	Delete a webhook
webhooks.listWebhookDeliveries()	GET	/api/v1/api/v1/projects/{project_id}/webhooks/{webhook_id}/deliveries	List deliveries for a webhook
webhooks.getWebhookDelivery()	GET	/api/v1/api/v1/projects/{project_id}/webhooks/{webhook_id}/deliveries/{delivery_id}	Get a delivery
webhooks.rotateWebhookSecret()	POST	/api/v1/api/v1/projects/{project_id}/webhooks/{webhook_id}/rotate-secret	Rotate webhook secret